diff options
author | Pauli Virtanen <pav@iki.fi> | 2013-05-04 00:43:40 +0300 |
---|---|---|
committer | Pauli Virtanen <pav@iki.fi> | 2013-05-04 00:43:40 +0300 |
commit | d68be9a15367d9703f221e3a5a22098d8921aaa4 (patch) | |
tree | ee52bc7435e71b67174c7486a82fb81791415049 | |
parent | c81879b1744a9dfc4baa38e2a3f6cdf12a73e72e (diff) | |
download | scipy-sphinx-theme-d68be9a15367d9703f221e3a5a22098d8921aaa4.tar.gz |
Update README.rst
-rw-r--r-- | README.rst | 29 |
1 files changed, 14 insertions, 15 deletions
@@ -10,36 +10,35 @@ Theme options The theme takes the followin options in the `html_options` configuration variable: -.. attribute:: edit_link +``edit_link`` - Either ``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. -.. attribute:: 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``. + breadcrumb list on the top left. You can override it by defining an + `edit_link` block in ``searchbox.html``. -.. attribute:: sidebar +``sidebar`` - One of ``"left"``, ``"right"``, ``"none"``. - Defines where the sidebar should appear. + One of ``"left"``, ``"right"``, ``"none"``. Defines where the sidebar + should appear. -.. attribute:: scipy_org_logo +``scipy_org_logo`` - 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. The following blocks are defined: -.. attribute:: layout.html:header +``layout.html:header`` Block at the top of the page, for logo etc. -.. attribute:: 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. |