You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,8 +35,7 @@ Via package
35
35
Download the package or add it to your ``requirements.txt`` file:
36
36
37
37
.. code:: bash
38
-
39
-
$ pip install sphinx_rtd_theme
38
+
$ pip install sphinx_rtd_theme
40
39
41
40
In your ``conf.py`` file:
42
41
@@ -268,6 +267,20 @@ way for me to ignore your request. RST unfortunately can spit out a lot of thing
268
267
in a lot of ways. I don't have time to research your problem for you, but I do
269
268
have time to fix the actual styling issue if you can replicate the problem for me.
270
269
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
0 commit comments