Skip to content

Commit 9aec9a9

Browse files
committed
Add proper options docs
1 parent 07b2522 commit 9aec9a9

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.rst

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,26 +90,41 @@ file of this repository, and can be defined in your project's ``conf.py`` via
9090
'typekit_id': '',
9191
'canonical_url': '',
9292
'analytics_id': '',
93-
'collapse_navigation': False,
94-
'sticky_navigation': True,
95-
'navigation_depth': 4,
96-
'includehidden': True,
9793
'logo_only': False,
9894
'display_version': True,
9995
'prev_next_buttons_location': bottom,
10096
'style_external_links': False,
97+
# Toc options
98+
'collapse_navigation': False,
99+
'sticky_navigation': True,
100+
'navigation_depth': 4,
101+
'includehidden': True,
101102
}
102103
103104
The following options are available:
104105

106+
Base options
107+
~~~~~~~~~~~~
108+
109+
* ``typekit_id`` This will let users specify a typekit id to use for displaying nicer fonts.
105110
* ``canonical_url`` This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__
106111
to let search engines know they should give higher ranking to latest version of the docs.
107112
The url points to the root of the documentation and requires a trailing slash.
108-
* ``includehidden`` Specifies if the global toctree includes toctrees marked with the `:hidden:` option
113+
* ``analytics_id`` Change the Google Analytics ID that is included on pages.
114+
* ``display_version`` With this disabled, the version number isn't shown at the top of the sidebar.
109115
* ``prev_next_buttons_location`` can take the value ``bottom``, ``top``, ``both`` , or ``None``
110116
and will display the "Next" and "Previous" buttons accordingly
111117
* ``style_external_links`` Add an icon next to external links. Defaults to ``False``.
112118

119+
TOC Options
120+
~~~~~~~~~~~
121+
122+
These effect how we display the Table of Contents in the side bar. You can read more about them here: http://www.sphinx-doc.org/en/stable/templating.html#toctree
123+
124+
* ``collapse_navigation`` With this enabled, you will lose the `[+]` drop downs next to each section in the sidebar. This is useful for _very large_ documents.
125+
* ``sticky_navigation`` This causes the sidebar to scroll with the main page content as you scroll the page.
126+
* ``includehidden`` Specifies if the sidebar includes toctrees marked with the `:hidden:` option
127+
113128
Page-level configuration
114129
------------------------
115130

0 commit comments

Comments
 (0)