Skip to content

Commit 102a07f

Browse files
committed
DOC: improve README
1 parent cd80a7d commit 102a07f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,25 @@ installation.
1616

1717
See the ``docs/conf.py`` file for other settings.
1818

19+
There are three main templates that replace the defaults in ``pydata-sphinx-theme``:
20+
21+
.. code-block::
22+
23+
navbar_start = mpl_navbar_logo.html
24+
navbar_center = mpl_nav_bar.html
25+
navbar_end = mpl_icon_links.html
26+
27+
Note that the option ``html_logo`` need not be specified as it is included
28+
in ``mpl_sphinx_theme/mpl_navbar_logo.html``. The logo is stored at
29+
``mpl_sphinx_theme/static/images/logo2.svg``.
30+
31+
To change the top navbar, edit ``mpl_sphinx_theme/mpl_nav_bar.html``
32+
33+
To change the social icons, edit ``mpl_sphinx_theme/mpl_icon_links.html``
34+
35+
To change the style, edit ``mpl_sphinx_theme/static/css/style.css``
36+
37+
1938
Releasing
2039
---------
2140

0 commit comments

Comments
 (0)