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 branch 'master' into fix-pygments

Browse Source
This commit is contained in:
Aaron Carlisle 2017-11-30 13:15:08 -05:00 committed by GitHub
commit bb9ef27225
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -87,9 +87,16 @@ 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 = {
'collapse_navigation': False, 'typekit_id': hiw1hhg,
'display_version': False, 'canonical_url':
'navigation_depth': 3, 'analytics_id':
'collapse_navigation': False
'sticky_navigation': False
'navigation_depth': 4
'includehidden': True
'logo_only':
'display_version': True
'prev_next_buttons_location': bottom
} }
The following options are available: The following options are available:
@ -97,6 +104,9 @@ The following options are available:
* ``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
* ``prev_next_buttons_location`` can take the value ``bottom``, ``top``, ``both`` , or ``None``
and will display the "Next" and "Previous" buttons accordingly
Page-level configuration Page-level configuration
------------------------ ------------------------
@ -168,9 +178,7 @@ v0.1.10-alpha
* Removes Sphinx dependency * Removes Sphinx dependency
* Fixes hamburger on mobile display * Fixes hamburger on mobile display
* Adds a ``body_begin`` block to the template * Adds a ``body_begin`` block to the template
* Add ``prev_next_buttons_location`` which can take the value ``bottom``, * Added ``prev_next_buttons_location``
``top``, ``both`` , ``None`` and will display the "Next" and "Previous"
buttons accordingly
v0.1.9 v0.1.9
------ ------
@ -209,7 +217,7 @@ It's important to note that if you don't follow the same styling for your rST he
your documents, the toctree will misbuild, and the resulting menu might not show the correct your documents, the toctree will misbuild, and the resulting menu might not show the correct
depth when it renders. depth when it renders.
Also note that the table of contents is set with ``includehidden=true``. This allows you Also note that by default the table of contents is set with ``includehidden=True``. This allows you
to set a hidden toc in your index file with the hidden_ property that will allow you to set a hidden toc in your index file with the hidden_ property that will allow you
to build a toc without it rendering in your index. to build a toc without it rendering in your index.

2
sphinx_rtd_theme/layout.html
View File

@ -133,7 +133,7 @@
toctree is empty. Skip building this for now. toctree is empty. Skip building this for now.
#} #}
{% if 'singlehtml' not in builder %} {% if 'singlehtml' not in builder %}
{% set global_toc = toctree(maxdepth=theme_navigation_depth|int, collapse=theme_collapse_navigation, includehidden=True) %} {% set global_toc = toctree(maxdepth=theme_navigation_depth|int, collapse=theme_collapse_navigation, includehidden=theme_includehidden) %}
{% endif %} {% endif %}
{% if global_toc %} {% if global_toc %}
{{ global_toc }} {{ global_toc }}

15
sphinx_rtd_theme/theme.conf
View File

@ -4,11 +4,12 @@ stylesheet = css/theme.css
[options] [options]
typekit_id = hiw1hhg typekit_id = hiw1hhg
analytics_id =
sticky_navigation = False
logo_only =
collapse_navigation = False
display_version = True
navigation_depth = 4
prev_next_buttons_location = bottom
canonical_url = canonical_url =
analytics_id =
collapse_navigation = False
sticky_navigation = False
navigation_depth = 4
includehidden = True
logo_only =
display_version = True
prev_next_buttons_location = bottom