IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #499 from rtfd/fix-stickynav-default

Browse Source 
Default stickynav to on properly.
This commit is contained in:
Eric Holscher 2017-12-15 10:56:10 -08:00 committed by GitHub
commit 59a37b3af9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.rst
View File

@ -87,29 +87,44 @@ file of this repository, and can be defined in your project's ``conf.py`` via
.. code:: python .. code:: python
html_theme_options = { html_theme_options = {
'typekit_id': hiw1hhg, 'typekit_id': '',
'canonical_url': 'canonical_url': '',
'analytics_id': 'analytics_id': '',
'collapse_navigation': False 'logo_only': False,
'sticky_navigation': False 'display_version': True,
'navigation_depth': 4
'includehidden': True
'logo_only':
'display_version': True
'prev_next_buttons_location': bottom, 'prev_next_buttons_location': bottom,
'style_external_links': False 'style_external_links': False,
# Toc options
'collapse_navigation': False,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
} }
The following options are available: The following options are available:
Base options
~~~~~~~~~~~~
* ``typekit_id`` This will let users specify a typekit id to use for displaying nicer fonts.
* ``canonical_url`` This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__ * ``canonical_url`` This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__
to let search engines know they should give higher ranking to latest version of the docs. to let search engines know they should give higher ranking to latest version of the docs.
The url points to the root of the documentation and requires a trailing slash. The url points to the root of the documentation and requires a trailing slash.
* ``includehidden`` Specifies if the global toctree includes toctrees marked with the `:hidden:` option * ``analytics_id`` Change the Google Analytics ID that is included on pages.
* ``display_version`` With this disabled, the version number isn't shown at the top of the sidebar.
* ``prev_next_buttons_location`` can take the value ``bottom``, ``top``, ``both`` , or ``None`` * ``prev_next_buttons_location`` can take the value ``bottom``, ``top``, ``both`` , or ``None``
and will display the "Next" and "Previous" buttons accordingly and will display the "Next" and "Previous" buttons accordingly
* ``style_external_links`` Add an icon next to external links. Defaults to ``False``. * ``style_external_links`` Add an icon next to external links. Defaults to ``False``.
TOC Options
~~~~~~~~~~~
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
* ``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.
* ``sticky_navigation`` This causes the sidebar to scroll with the main page content as you scroll the page.
* ``includehidden`` Specifies if the sidebar includes toctrees marked with the `:hidden:` option
Page-level configuration Page-level configuration
------------------------ ------------------------

2
sphinx_rtd_theme/theme.conf
View File

@ -8,7 +8,7 @@ typekit_id = hiw1hhg
canonical_url = canonical_url =
analytics_id = analytics_id =
collapse_navigation = False collapse_navigation = False
sticky_navigation = False sticky_navigation = True
navigation_depth = 4 navigation_depth = 4
includehidden = True includehidden = True
logo_only = logo_only =