Skip to content

Commit

Permalink
add note about archiving docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Naomi Slater committed Jul 17, 2017
1 parent ffac82c commit b670bc1
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion DEVELOP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,12 @@ To create a new release, you must:

- Create a tag by running ``./devtools/create_tag.sh``

- Deploy to PyPI (see section below)

- Archive docs for old releases (see section below)

PyPI Deployment
===============
---------------

To create the package use::

Expand Down Expand Up @@ -96,6 +100,33 @@ If you want to check the PyPI description before uploading, run::

$ bin/py setup.py check --strict --restructuredtext

Archiving Docs Versions
-----------------------

Check the `versions hosted on ReadTheDocs`_.

We should only be hosting the docs for `latest`, `stable`, and the most recent
patch versions for the last two minor releases.

Here's an example:

- latest
- stable
- 0.21.3
- 0.20.1

Here's what you might do:

- If you were releasing g0.22.0, you would archive 0.20.1
- If you were releasing 0.21.4, you would archive 0.21.3
- If you were releasing 0.20.2, you would archive 0.20.1

Sometimes you might find that there are multiple older releases that need to be
archived.

You can archive releases by selecting *Edit*, unselecting the *Active*
checkbox, and then saving.

Standalone Deployment
=====================

Expand Down Expand Up @@ -126,3 +157,4 @@ nothing special you need to do to get the live docs to update.
.. _tox: http://testrun.org/tox/latest/
.. _twine: https://pypi.python.org/pypi/twine
.. _zope.testrunner: https://pypi.python.org/pypi/zope.testrunner/4.4.1
.. _versions hosted on ReadTheDocs: https://readthedocs.org/projects/crash/versions/

0 comments on commit b670bc1

Please sign in to comment.