Skip to content

Commit

Permalink
Simple sphinx settings to improve navigation (#93)
Browse files Browse the repository at this point in the history
* Quality of life options for sidebar and navigation

* Clarify what the defaults were

* Keep nav depth at default 4 because page sections are long atm
  • Loading branch information
cbkerr authored Jul 27, 2020
1 parent 971190a commit 8b8e113
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,10 @@
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
html_theme_options = {
'collapse_navigation': False, # now show the [+] icon to expand headings in the sidebar. Default=True
'prev_next_buttons_location': 'both' # helps quicken skimming through doc pages. Default='bottom'
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down

0 comments on commit 8b8e113

Please sign in to comment.