|
1 |
| -Dask Sphinx Theme |
2 |
| -================= |
| 1 | +Matplotlib Sphinx Theme |
| 2 | +======================= |
3 | 3 |
|
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. |
7 | 6 |
|
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 |
9 | 8 | line in your conf.py file
|
10 | 9 |
|
11 | 10 | .. code-block:: python
|
12 | 11 |
|
13 |
| - html_theme = 'dask_sphinx_theme' |
| 12 | + html_theme = 'mpl_sphinx_theme' |
14 | 13 |
|
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 |
16 | 15 | installation.
|
17 | 16 |
|
18 |
| -Releasing |
19 |
| ---------- |
| 17 | +Releasing [TODO] |
| 18 | +---------------- |
20 | 19 |
|
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>`_ |
22 | 21 | to automatically push a new release to PyPI whenever
|
23 | 22 | 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, |
25 | 24 | 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: |
27 | 26 |
|
28 | 27 | .. code-block::
|
29 | 28 |
|
30 | 29 | $ git checkout <commit-hash>
|
31 | 30 | $ git tag -a x.y.z -m 'Version x.y.z'
|
32 | 31 | $ git push upstream main --tags
|
33 | 32 |
|
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>`_ |
36 | 35 | for the new ``x.y.z`` release will automatically be opened by conda-forge bots.
|
0 commit comments