blob: 3f1d64af52c880238def1ba310d9198baec8b9f6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
scipy-sphinx-theme
==================
`Sphinx <http://sphinx-doc.org>`__ theme for `Scipy <http://scipy.org>`__.
Theme options
-------------
The theme takes the followin options in the `html_options`
configuration variable:
.. attribute:: edit_link
Either ``true`` or ``false``. Determines if an "edit this page"
link is displayed in the left sidebar.
.. attribute:: 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``.
.. attribute:: sidebar
One of ``"left"``, ``"right"``, ``"none"``.
Defines where the sidebar should appear.
.. attribute:: scipy_org_logo
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
Block at the top of the page, for logo etc.
.. attribute:: searchbox.html:edit_link
Edit link HTML code to paste in the left sidebar, if `edit_link` is
enabled.
|
