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

docs: Improve toctrees & sidebar formatting #1773

Merged
merged 12 commits into from
Nov 16, 2022
Merged

docs: Improve toctrees & sidebar formatting #1773

merged 12 commits into from
Nov 16, 2022

Conversation

BobDotCom
Copy link
Member

Summary

  • Adds a caption to sidebar toctrees
  • Categorizes sidebar items
  • Shortens sidebar extension names by removing description

Information

  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed).
  • This PR is not a code change (e.g. documentation, README, typehinting,
    examples, ...).

Checklist

  • I have searched the open pull requests for duplicates.
  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • If type: ignore comments were used, a comment is also left explaining why.

I'm not sure if this change should be made yet, so I'm not going to include it in this PR
@BobDotCom BobDotCom added documentation Improvements or additions to documentation priority: low Low Priority status: awaiting review Awaiting review from a maintainer labels Nov 9, 2022
@BobDotCom BobDotCom added this to the v2.3 milestone Nov 9, 2022
@BobDotCom BobDotCom requested a review from a team as a code owner November 9, 2022 17:06
@BobDotCom BobDotCom self-assigned this Nov 9, 2022
@BobDotCom BobDotCom enabled auto-merge (squash) November 9, 2022 17:07
@BobDotCom BobDotCom requested a review from a team November 10, 2022 20:21
@BobDotCom BobDotCom requested a review from a team November 15, 2022 17:15
@BobDotCom BobDotCom merged commit 0a6079d into master Nov 16, 2022
@BobDotCom BobDotCom deleted the toctrees branch November 16, 2022 19:20
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 priority: low Low Priority status: awaiting review Awaiting review from a maintainer
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants