IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Address review feedback

Browse Source
This commit is contained in:
Eric Holscher 2017-04-18 09:58:24 -07:00
parent 352057c08c
commit 57a718370b
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@ -274,12 +274,13 @@ 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.
* Bump the version in ``sphinx_rtd_theme/__init__.py`` - we try to follow `semver <http://semver.org/>`_, so be careful with breaking changes.
* Run a ``grunt build`` to rebuild all the theme assets.
* 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, edit the ``bower.json`` file to point at the correct version (``sphinx-rtd-theme": "https://github.com/rtfd/sphinx-rtd-theme.git#$NEW_VERSION"``)
* In the ``readthedocs.org`` repo, run ``gulp build`` to update the distributed theme files
TODO