From 4fff7fe5b9afb0a8a1d3817893ca94a5e3a08d6d Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Mon, 17 Apr 2017 13:41:21 -0700 Subject: [PATCH 1/3] 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. --- README.rst | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index a649b5dd..6c0d42c0 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 `_, 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 ==== From 352057c08cedd7348ef7fe09ebd3388c0c412daf Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Mon, 17 Apr 2017 13:44:36 -0700 Subject: [PATCH 2/3] Fix indent erro --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 6c0d42c0..6ef1aebe 100644 --- a/README.rst +++ b/README.rst @@ -35,7 +35,8 @@ 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: From 57a718370b402cc937bfa2cf65f9f5e2ef0bae10 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 18 Apr 2017 09:58:24 -0700 Subject: [PATCH 3/3] Address review feedback --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 6ef1aebe..d45d0af3 100644 --- a/README.rst +++ b/README.rst @@ -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 `_, so be careful with breaking changes. +* Bump the version in ``sphinx_rtd_theme/__init__.py`` - we try to follow `semver `_, 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