Skip to content

Commit 68c9160

Browse files
committed
DOC: fix README.rst
1 parent e71647e commit 68c9160

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.rst

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,35 @@
1-
Dask Sphinx Theme
2-
=================
1+
Matplotlib Sphinx Theme
2+
=======================
33

4-
This is the official Sphinx theme for Dask documentation. It extends the
5-
``sphinx-book-theme`` project, but adds custom styling and a navigation bar to
6-
additional Dask subprojects.
4+
This is the official Sphinx theme for Matplotlib documentation. It extends the
5+
``pydata-sphinx-theme`` project, but adds custom styling and a navigation bar.
76

8-
When creating a Dask subproject you can include this theme by changing this
7+
When creating a Matplotlib subproject you can include this theme by changing this
98
line in your conf.py file
109

1110
.. code-block:: python
1211
13-
html_theme = 'dask_sphinx_theme'
12+
html_theme = 'mpl_sphinx_theme'
1413
15-
And by including ``dask_sphinx_theme`` as a requirement in your documentation
14+
And by including ``mpl_sphinx_theme`` as a requirement in your documentation
1615
installation.
1716

18-
Releasing
19-
---------
17+
Releasing [TODO]
18+
----------------
2019

21-
This project `uses GitHub Actions <https://github.com/dask/dask-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml>`_
20+
This project `uses GitHub Actions <https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml>`_
2221
to automatically push a new release to PyPI whenever
2322
a git tag is pushed. For example, to release a new ``x.y.z`` version of
24-
``dask-sphinx-theme``, checkout the commit you would like to release,
23+
``mpl-sphinx-theme``, checkout the commit you would like to release,
2524
add a git tag, and push the tag to the ``main`` branch of the
26-
``dask/dask-sphinx-theme`` repository:
25+
``matplotlib/mpl-sphinx-theme`` repository:
2726

2827
.. code-block::
2928
3029
$ git checkout <commit-hash>
3130
$ git tag -a x.y.z -m 'Version x.y.z'
3231
$ git push upstream main --tags
3332
34-
After a new release is published on PyPI, a pull request to the ``dask-sphinx-theme``
35-
`conda-forge feedstock <https://github.com/conda-forge/dask-sphinx-theme-feedstock>`_
33+
After a new release is published on PyPI, a pull request to the ``mpl-sphinx-theme``
34+
`conda-forge feedstock <https://github.com/conda-forge/mpl-sphinx-theme-feedstock>`_
3635
for the new ``x.y.z`` release will automatically be opened by conda-forge bots.

0 commit comments

Comments
 (0)