You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To change the top navbar, edit ``mpl_sphinx_theme/mpl_nav_bar.html``
32
+
To change the top navbar, edit `mpl_sphinx_theme/mpl_nav_bar.html`
32
33
33
-
To change the social icons, edit ``mpl_sphinx_theme/mpl_icon_links.html``
34
+
To change the social icons, edit `mpl_sphinx_theme/mpl_icon_links.html`
34
35
35
-
To change the style, edit ``mpl_sphinx_theme/static/css/style.css``
36
+
To change the style, edit `mpl_sphinx_theme/static/css/style.css`
36
37
37
38
## Overriding hard coded elements
38
39
@@ -42,33 +43,33 @@ and [list of third-party packages](https://github.com/matplotlib/mpl-third-party
42
43
As such several elements are hard coded. However, the theme may also be used by
43
44
other subprojects that need to change the hard-coded defaults.
44
45
The following sections explain how to reset these back to their defaults by modifying
45
-
``html_theme_options`` in ``conf.py``.
46
+
`html_theme_options` in `conf.py`.
46
47
47
48
### Header section links
48
49
49
-
Use a copy of [the default pydata-sphinx-theme navbar](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html) and set the ``'navbar_center'`` key to this HTML file in ``html_theme_options``.
50
+
Use a copy of [the default pydata-sphinx-theme navbar](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html) and set the `'navbar_center'` key to this HTML file in `html_theme_options`.
50
51
51
52
## Building
52
53
53
-
To build the theme with a sample page, navigate into the ``doc/`` directory and run
54
+
To build the theme with a sample page, navigate into the `doc/` directory and run
54
55
55
56
```
56
57
make html
57
58
```
58
59
59
-
The built html pages can be found in ``doc/_build/html/``
60
+
The built html pages can be found in `doc/_build/html/`
60
61
61
62
## Releasing
62
63
63
64
This project [uses GitHub Actions](https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/release.yml)
64
65
to automatically push a new release to PyPI whenever a release is made.
65
66
66
-
For example, to release a new ``3.9.0`` version of ``mpl-sphinx-theme``:
67
+
For example, to release a new `3.9.0` version of `mpl-sphinx-theme`:
67
68
68
69
- be sure to edit `mpl_sphinx_theme/_version.py`
69
70
- checkout the commit you would like to release
70
71
- add a git tag
71
-
- push the tag to the ``matplotlib/mpl-sphinx-theme`` repository
72
+
- push the tag to the `matplotlib/mpl-sphinx-theme` repository
72
73
73
74
```sh
74
75
git checkout <commit-hash>
@@ -78,10 +79,10 @@ git push upstream --tags
78
79
79
80
Finally, [turn the tag into a GitHub release](https://github.com/matplotlib/mpl-sphinx-theme/releases/new).
80
81
81
-
Update the required ``mpl-sphinx-theme`` version in the following files:
82
+
Update the required `mpl-sphinx-theme` version in the following files:
0 commit comments