Skip to content

Commit 4fff7fe

Browse files
committed
Add some basic docs around releasing the theme.
This just covers the basic tasks that I know need to happen, feel free to suggest other improvements.
1 parent 4be9ff3 commit 4fff7fe

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.rst

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ Via package
3535
Download the package or add it to your ``requirements.txt`` file:
3636

3737
.. code:: bash
38-
39-
$ pip install sphinx_rtd_theme
38+
$ pip install sphinx_rtd_theme
4039

4140
In your ``conf.py`` file:
4241

@@ -268,6 +267,20 @@ way for me to ignore your request. RST unfortunately can spit out a lot of thing
268267
in a lot of ways. I don't have time to research your problem for you, but I do
269268
have time to fix the actual styling issue if you can replicate the problem for me.
270269

270+
Releasing the Theme
271+
===================
272+
273+
When you release a new version,
274+
you should do the following:
275+
276+
* Bump the version in ``sphinx_rtd_theme/__init__.py`` - we try to follow `semvar <http://semver.org/>`_, so be careful with breaking changes.
277+
* Commit that change
278+
* Tag the release in git: ``git tag $NEW_VERSION``.
279+
* Push the tag to GitHub: ``git push --tags origin``
280+
* Upload the package to PyPI: ``python setup.py sdist bdist_wheel upload``
281+
* In the ``readthedocs.org`` repo, edit the ``bower.json`` file to point at the correct version (``sphinx-rtd-theme": "https://github.com/snide/sphinx-rtd-theme.git#$NEW_VERSION"``)
282+
* In the ``readthedocs.org`` repo, run ``gulp build`` to update the distributed theme files
283+
271284
TODO
272285
====
273286

0 commit comments

Comments
 (0)