Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/readthedocs/sphinx_rtd_theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Holscher <eric@ericholscher.com>2017-04-17 23:41:21 +0300
committerEric Holscher <eric@ericholscher.com>2017-04-17 23:43:33 +0300
commit4fff7fe5b9afb0a8a1d3817893ca94a5e3a08d6d (patch)
treedf3bc2ced664c0052d649cda8f16f4de67605c8b
parent4be9ff3fd19c779559a0b9eab70e4767a0f77c01 (diff)
Add some basic docs around releasing the theme.0.2.5b1
This just covers the basic tasks that I know need to happen, feel free to suggest other improvements.
-rw-r--r--README.rst17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index a649b5d..6c0d42c 100644
--- a/README.rst
+++ b/README.rst
@@ -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:
@@ -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
====