Skip to content

Commit ef7aed5

Browse files
committed
Clean up double backticks
1 parent 468e7f9 commit ef7aed5

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,39 @@
11
# Matplotlib Sphinx Theme
22

3-
This is the official Sphinx theme for Matplotlib documentation. It extends the
4-
``pydata-sphinx-theme`` project, but adds custom styling and a navigation bar.
3+
This is the official Sphinx theme for Matplotlib documentation. It extends the
4+
`pydata-sphinx-theme` project, but adds custom styling and a navigation bar.
55

6-
A demo of the theme built with the ``main`` branch can be seen at
6+
A demo of the theme built with the `main` branch can be seen at
77
https://matplotlib.org/mpl-sphinx-theme/.
88

99
When creating a Matplotlib subproject you can include this theme by changing this
10-
line in your ``conf.py`` file
10+
line in your `conf.py` file
1111

1212
```python
1313
html_theme = 'mpl_sphinx_theme'
1414
```
1515

16-
And by including ``mpl_sphinx_theme`` as a requirement in your documentation
16+
And by including `mpl_sphinx_theme` as a requirement in your documentation
1717
installation.
1818

19-
See the ``docs/conf.py`` file for other settings.
19+
See the `docs/conf.py` file for other settings.
2020

21-
There are two main templates that replace the defaults in ``pydata-sphinx-theme``:
21+
There are two main templates that replace the defaults in `pydata-sphinx-theme`:
2222

2323
```
2424
navbar_center = mpl_nav_bar.html
2525
navbar_end = mpl_icon_links.html
2626
```
27+
2728
Note that the logo options need not be specified as they are included in theme
2829
initialization. The logo is stored at
29-
``mpl_sphinx_theme/static/logo_{light,dark}.svg``.
30+
`mpl_sphinx_theme/static/logo_{light,dark}.svg`.
3031

31-
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`
3233

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`
3435

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`
3637

3738
## Overriding hard coded elements
3839

@@ -42,33 +43,33 @@ and [list of third-party packages](https://github.com/matplotlib/mpl-third-party
4243
As such several elements are hard coded. However, the theme may also be used by
4344
other subprojects that need to change the hard-coded defaults.
4445
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`.
4647

4748
### Header section links
4849

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`.
5051

5152
## Building
5253

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
5455

5556
```
5657
make html
5758
```
5859

59-
The built html pages can be found in ``doc/_build/html/``
60+
The built html pages can be found in `doc/_build/html/`
6061

6162
## Releasing
6263

6364
This project [uses GitHub Actions](https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/release.yml)
6465
to automatically push a new release to PyPI whenever a release is made.
6566

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`:
6768

6869
- be sure to edit `mpl_sphinx_theme/_version.py`
6970
- checkout the commit you would like to release
7071
- 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
7273

7374
```sh
7475
git checkout <commit-hash>
@@ -78,10 +79,10 @@ git push upstream --tags
7879

7980
Finally, [turn the tag into a GitHub release](https://github.com/matplotlib/mpl-sphinx-theme/releases/new).
8081

81-
Update the required ``mpl-sphinx-theme`` version in the following files:
82+
Update the required `mpl-sphinx-theme` version in the following files:
8283

83-
* [matplotlib/matplotlib](https://github.com/matplotlib/matplotlib): requirements/doc/doc-requirements.txt
84-
* [matplotlib/mpl-brochure-site](https://github.com/matplotlib/mpl-brochure-site): requirements.txt
85-
* [matplotlib/mpl-third-party](https://github.com/matplotlib/mpl-third-party): docs/requirements.txt
86-
* [matplotlib/governance](https://github.com/matplotlib/governance): requirements-doc.txt
87-
* [matplotlib/mpl-gui](https://github.com/matplotlib/mpl-gui): requirements-doc.txt
84+
- [matplotlib/matplotlib](https://github.com/matplotlib/matplotlib): requirements/doc/doc-requirements.txt
85+
- [matplotlib/mpl-brochure-site](https://github.com/matplotlib/mpl-brochure-site): requirements.txt
86+
- [matplotlib/mpl-third-party](https://github.com/matplotlib/mpl-third-party): docs/requirements.txt
87+
- [matplotlib/governance](https://github.com/matplotlib/governance): requirements-doc.txt
88+
- [matplotlib/mpl-gui](https://github.com/matplotlib/mpl-gui): requirements-doc.txt

0 commit comments

Comments
 (0)