DOC: Updated with latest release process

This commit is contained in:
Richard Frank
2016-02-24 18:51:48 -05:00
parent 6b401cf656
commit 3bca062cd7
2 changed files with 80 additions and 7 deletions
+21 -7
View File
@@ -18,13 +18,11 @@ Edit the release date field to be today's date in the format:
<month> <day>, <year>
then include this file in ``docs/source/releases.rst``. New releases should
appear at the top. The syntax for this is:
::
.. include:: whatsnew/<version>.txt
for example, November 6, 2015.
Remove the active development warning from the whatsnew, since it will no
longer be pending release.
Update the title of the release from "Development" to "Release x.x.x" and
update the underline of the title to match the title's width.
Updating the ``__version__``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -193,3 +191,19 @@ Once we are happy, push the updated docs to the GitHub ``gh-pages`` branch.
$ git push origin gh-pages
`zipline.io <http://www.zipline.io/index.html>`__ will update in a few moments.
Next Commit
~~~~~~~~~~~
Push a new commit post-release that adds the whatsnew for the next release,
which should be titled according to a micro version increment. If that next
release turns out to be a major/minor version increment, the file can be
renamed when that's decided. You can use ``docs/source/whatsnew/skeleton.txt``
as a template for the new file.
Include the whatsnew file in ``docs/source/releases.rst``. New releases should
appear at the top. The syntax for this is:
::
.. include:: whatsnew/<version>.txt
+59
View File
@@ -0,0 +1,59 @@
Development
-----------
:Release: x.x.x
:Date: TBD
.. warning::
This release is still under active development. All changes listed are
subject to change at any time.
Highlights
~~~~~~~~~~
None
Enhancements
~~~~~~~~~~~~
None
Experimental Features
~~~~~~~~~~~~~~~~~~~~~
.. warning::
Experimental features are subject to change.
None
Bug Fixes
~~~~~~~~~
None
Performance
~~~~~~~~~~~
None
Maintenance and Refactorings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
None
Build
~~~~~
None
Documentation
~~~~~~~~~~~~~
None
Miscellaneous
~~~~~~~~~~~~~
None