Skip to content

📚 Use furo Sphinx theme for documentation#676

Merged
cjolowicz merged 9 commits intomainfrom
docs/furo
Nov 12, 2021
Merged

📚 Use furo Sphinx theme for documentation#676
cjolowicz merged 9 commits intomainfrom
docs/furo

Conversation

@cjolowicz
Copy link
Copy Markdown
Owner

  • ➕ [poetry] Add furo >=2021.11.12 to development dependencies
  • 👷 [nox] Install furo in docs and docs-build sessions
  • ➕ [docs] Add furo==2021.11.12 to requirements
  • 🔧 [docs] Use furo Sphinx theme
  • 📚 [docs] Remove table of contents from API Reference
  • 📚 [docs] Generate API documentation for package not __main__
  • ➖ [docs] Remove sphinx-rtd-theme from requirements
  • 👷 [nox] Do not install sphinx-rtd-theme in docs and docs-build sessions
  • ➖ [poetry] Remove sphinx-rtd-theme from development dependencies

The table of contents duplicates furo's right sidebar.
`reference.rst` inserts the API documentation for the `__main__` module. That
makes little sense, as it only contains the Click entry point, whose docstring
is not intended for consumption by Sphinx.

Instead, insert API documentation for the package. This generates documentation
for anything in `__init__`. On project generation, this is only be the package
docstring, which is fine.
@cjolowicz cjolowicz added the documentation Improvements or additions to documentation label Nov 12, 2021
@cjolowicz cjolowicz merged commit 272d565 into main Nov 12, 2021
@cjolowicz cjolowicz deleted the docs/furo branch November 12, 2021 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant