Skip to content

Commit b10c471

Browse files
authored
Merge pull request #6 from jklymak/doc-update-readme
DOC: update readme a bit
2 parents 94c6729 + df0de4c commit b10c471

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.rst

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is the official Sphinx theme for Matplotlib documentation. It extends the
55
``pydata-sphinx-theme`` project, but adds custom styling and a navigation bar.
66

77
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
99

1010
.. code-block:: python
1111
@@ -14,22 +14,29 @@ line in your conf.py file
1414
And by including ``mpl_sphinx_theme`` as a requirement in your documentation
1515
installation.
1616

17-
Releasing [TODO]
18-
----------------
17+
See the ``docs/conf.py`` file for other settings.
1918

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.
2624

2725
.. code-block::
2826
2927
$ git checkout <commit-hash>
3028
$ git tag -a x.y.z -m 'Version x.y.z'
3129
$ 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:
3239

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``
3441
`conda-forge feedstock <https://github.com/conda-forge/mpl-sphinx-theme-feedstock>`_
3542
for the new ``x.y.z`` release will automatically be opened by conda-forge bots.

0 commit comments

Comments
 (0)