Skip to content

Commit

Permalink
Add some basic docs around releasing the theme.
Browse files Browse the repository at this point in the history
This just covers the basic tasks that I know need to happen,
feel free to suggest other improvements.
  • Loading branch information
ericholscher committed Apr 17, 2017
1 parent 4be9ff3 commit 4fff7fe
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ Via package
Download the package or add it to your ``requirements.txt`` file:

.. code:: bash
$ pip install sphinx_rtd_theme
$ pip install sphinx_rtd_theme

In your ``conf.py`` file:

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

Releasing the Theme
===================

When you release a new version,
you should do the following:

* Bump the version in ``sphinx_rtd_theme/__init__.py`` - we try to follow `semvar <http://semver.org/>`_, so be careful with breaking changes.
* Commit that change
* Tag the release in git: ``git tag $NEW_VERSION``.
* Push the tag to GitHub: ``git push --tags origin``
* Upload the package to PyPI: ``python setup.py sdist bdist_wheel upload``
* 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"``)
* In the ``readthedocs.org`` repo, run ``gulp build`` to update the distributed theme files

TODO
====

Expand Down

0 comments on commit 4fff7fe

Please sign in to comment.