Release checklist
=================

* open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green
* Run `git status` and check nothing changed
* Update sphinx/locale/sphinx.pot if first major release (beta1)

  * Run `python setup.py extract_messages`
  * Run `(cd sphinx/locale; tx push -s)`

* Update sphinx/locale/<lang>/ files if final major release ...

  * Run `(cd sphinx/locale; tx pull -a -f)`
  * Run `python setup.py compile_catalog`
  * Run `git commit -am 'Update message catalogs'`

* `python utils/bump_version.py X.Y.Z`
* Check diff by `git diff`
* Edit CHANGES if empty section exists
* `git commit -am 'Bump to X.Y.Z final'`
* `make clean`
* `python setup.py release bdist_wheel sdist upload --identity=[your key]`
* open https://pypi.python.org/pypi/Sphinx and check there are no obvious errors
* `git tag vX.Y.Z` with version number
* Merge default into X.Y branch if final major release
* `git push origin X.Y --tags`
* open https://readthedocs.org/dashboard/sphinx/versions/ and enable the released version
* Add new version/milestone to tracker categories
* `python utils/bump_version.py --in-develop X.Y.Zb0` (ex. 1.5.3b0)
* Check diff by `git diff`
* `git commit -am 'Bump version'`
* `git push origin X.Y`
* `git checkout master`
* `git merge X.Y`
* `git push origin master`
* Update `sphinx-doc-translations <https://github.com/sphinx-doc/sphinx-doc-translations>`_
* Write announcement and send to sphinx-dev, sphinx-users and python-announce