Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #1267

Merged
merged 12 commits into from
Jun 27, 2022
Merged

Improve documentation #1267

merged 12 commits into from
Jun 27, 2022

Conversation

danieljanes
Copy link
Member

@danieljanes danieljanes commented Jun 25, 2022

Documentation improvements:

  • Remove private flwr.typing module from API ref
  • Migrate changelog from .rst to .md to make it easier to C&P release notes to GitHub releases. This also adds general support for MarkDown-based documentation, so any other piece of documentation could use it as well.
  • Migrate from (unmaintained) sphinx_panels to the successor sphinx_design to fix FAQ incompatibility with Furo dark theme
  • Remove Legacy Examples from top-level navigation
  • Remove Python 3.6 references
  • Update docs-related dependencies
  • Update title of some docs to make the index easier to parse for new users
  • Add Join us on Slack button to the docs landing page

@danieljanes danieljanes enabled auto-merge (squash) June 25, 2022 18:59
@tanertopal tanertopal disabled auto-merge June 27, 2022 11:56
@tanertopal tanertopal enabled auto-merge (squash) June 27, 2022 11:56
@tanertopal tanertopal merged commit 3763320 into main Jun 27, 2022
@tanertopal tanertopal deleted the docs branch June 27, 2022 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants