diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 41 |
1 files changed, 23 insertions, 18 deletions
@@ -10,35 +10,40 @@ Theme options The theme takes the followin options in the `html_options` configuration variable: -``edit_link`` +- ``edit_link`` - ``True`` or ``False``. Determines if an "edit this page" link is displayed - in the left sidebar. + ``True`` or ``False``. Determines if an "edit this page" link is displayed + in the left sidebar. -``rootlinks`` +- ``rootlinks`` - List of tuples ``(url, link_name)`` to show in the beginning of the - breadcrumb list on the top left. You can override it by defining an - `edit_link` block in ``searchbox.html``. + List of tuples ``(url, link_name)`` to show in the beginning of the + breadcrumb list on the top left. You can override it by defining an + `edit_link` block in ``searchbox.html``. -``sidebar`` +- ``sidebar`` - One of ``"left"``, ``"right"``, ``"none"``. Defines where the sidebar - should appear. + One of ``"left"``, ``"right"``, ``"none"``. Defines where the sidebar + should appear. -``scipy_org_logo`` +- ``scipy_org_logo`` - ``True`` or ``False``. Whether to plaster the scipy.org logo on top. + ``True`` or ``False``. Whether to plaster the scipy.org logo on top. - You can use your own logo by overriding the :attr:`layout.html:header` - block. + You can use your own logo by overriding the :attr:`layout.html:header` + block. + +- ``navigation_links`` + + ``True`` or ``False``. Whether to display "next", "prev", "index", etc. + links. The following blocks are defined: -``layout.html:header`` +- ``layout.html:header`` - Block at the top of the page, for logo etc. + Block at the top of the page, for logo etc. -``searchbox.html:edit_link`` +- ``searchbox.html:edit_link`` - Edit link HTML code to paste in the left sidebar, if `edit_link` is enabled. + Edit link HTML code to paste in the left sidebar, if `edit_link` is enabled. |