@@ -5,7 +5,7 @@ This is the official Sphinx theme for Matplotlib documentation. It extends the
5
5
``pydata-sphinx-theme `` project, but adds custom styling and a navigation bar.
6
6
7
7
When creating a Matplotlib subproject you can include this theme by changing this
8
- line in your conf.py file
8
+ line in your `` conf.py `` file
9
9
10
10
.. code-block :: python
11
11
@@ -14,22 +14,29 @@ line in your conf.py file
14
14
And by including ``mpl_sphinx_theme `` as a requirement in your documentation
15
15
installation.
16
16
17
- Releasing [TODO]
18
- ----------------
17
+ See the ``docs/conf.py `` file for other settings.
19
18
20
- This project `uses GitHub Actions <https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml >`_
21
- to automatically push a new release to PyPI whenever
22
- a git tag is pushed. For example, to release a new ``x.y.z `` version of
23
- ``mpl-sphinx-theme ``, checkout the commit you would like to release,
24
- add a git tag, and push the tag to the ``main `` branch of the
25
- ``matplotlib/mpl-sphinx-theme `` repository:
19
+ Releasing
20
+ ---------
21
+
22
+ Manually for now... see the todo below for how we hope to eventually do it
23
+ automagically.
26
24
27
25
.. code-block ::
28
26
29
27
$ git checkout <commit-hash>
30
28
$ git tag -a x.y.z -m 'Version x.y.z'
31
29
$ git push upstream main --tags
30
+ $ python -m build -s -w
31
+ $ twine upload dist/mpl_sphinx_theme-x.y.z*
32
+
33
+ TODO: This project `uses GitHub Actions <https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml >`_
34
+ to automatically push a new release to PyPI whenever
35
+ a git tag is pushed. For example, to release a new ``x.y.z `` version of
36
+ ``mpl-sphinx-theme ``, checkout the commit you would like to release,
37
+ add a git tag, and push the tag to the ``main `` branch of the
38
+ ``matplotlib/mpl-sphinx-theme `` repository:
32
39
33
- After a new release is published on PyPI, a pull request to the ``mpl-sphinx-theme ``
40
+ TODO: After a new release is published on PyPI, a pull request to the ``mpl-sphinx-theme ``
34
41
`conda-forge feedstock <https://github.com/conda-forge/mpl-sphinx-theme-feedstock >`_
35
42
for the new ``x.y.z `` release will automatically be opened by conda-forge bots.
0 commit comments