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

Simple sphinx settings to improve navigation #93

Merged
merged 3 commits into from
Jul 27, 2020

Conversation

cbkerr
Copy link
Member

@cbkerr cbkerr commented Jul 24, 2020

Small fix to improve navigability of the docs while large scale projects like #64 continue.

Motivation

I always felt lost in the docs, particularly by not knowing the hierarchy of items in the sidebar.

Details

With these settings:

  • show a plus sign when mousing over headings in the sidebar to avoid having to click to load the page to expand the subtree
  • show navigation buttons at top and bottom of page because lots of our pages are long

The options are described here.

Before
old
After
new

Checklist:

@cbkerr cbkerr requested review from atravitz and pepak13 July 24, 2020 01:23
@cbkerr cbkerr requested review from a team as code owners July 24, 2020 01:23
Copy link
Collaborator

@atravitz atravitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good!

Copy link
Contributor

@pepak13 pepak13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice Feature!

@csadorf csadorf merged commit 8b8e113 into master Jul 27, 2020
@csadorf csadorf deleted the feature/html-theme-options branch July 27, 2020 16:48
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.

4 participants