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.

Sign up for GitHub

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

Jump to bottom

📚 Use furo Sphinx theme for documentation #676

Merged
merged 9 commits into from
Nov 12, 2021
Merged

📚 Use furo Sphinx theme for documentation #676

merged 9 commits into from
Nov 12, 2021

Conversation

cjolowicz
Copy link
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

@cjolowicz
➕ [poetry] Add furo >=2021.11.12 to development dependencies
351614d
@cjolowicz
👷 [nox] Install furo in docs and docs-build sessions
1049d1b
@cjolowicz
➕ [docs] Add furo==2021.11.12 to requirements
3d9a13a
@cjolowicz
🔧 [docs] Use furo Sphinx theme
7720e34
@cjolowicz
📚 [docs] Remove table of contents from API Reference
9accef4 
The table of contents duplicates furo's right sidebar.
@cjolowicz
📚 [docs] Generate API documentation for package not __main__
5b2263c 
`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
➖ [docs] Remove sphinx-rtd-theme from requirements
1760389
@cjolowicz
👷 [nox] Do not install sphinx-rtd-theme in docs and docs-build sessions
3da31f1
@cjolowicz
➖ [poetry] Remove sphinx-rtd-theme from development dependencies
4020f73
@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
@cjolowicz cjolowicz mentioned this pull request Nov 26, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@cjolowicz