提交 380281d8 authored 作者: Pascal Lamblin's avatar Pascal Lamblin

Update internal doc for release

上级 84ac684c
...@@ -11,16 +11,18 @@ Update the NEWS.txt and move the old stuff in the HISTORY.txt file. ...@@ -11,16 +11,18 @@ Update the NEWS.txt and move the old stuff in the HISTORY.txt file.
To update the NEWS.txt file, check all ticket closed for this release To update the NEWS.txt file, check all ticket closed for this release
and all commit log messages. and all commit log messages.
For the final release, copy the file Theano/NEWS.txt to Theano/doc/NEWS.txt For the final release, copy the file ``Theano/NEWS.txt`` to
``Theano/doc/NEWS.txt``.
Update the "Vision"/"Vision State" in the file Theano/doc/introduction.txt. Update the "Vision"/"Vision State" in the file
``Theano/doc/introduction.txt``.
Get a fresh copy of the repository Get a fresh copy of the repository
================================== ==================================
Clone the code:: Clone the code::
git clone git://github.com/Theano/Theano.git git clone git@github.com:Theano/Theano.git Theano-0.X
It does not have to be in your PYTHONPATH. It does not have to be in your PYTHONPATH.
...@@ -43,8 +45,8 @@ Update the year in the ``Theano/LICENSE.txt`` file too, if necessary. ...@@ -43,8 +45,8 @@ Update the year in the ``Theano/LICENSE.txt`` file too, if necessary.
too. too.
Update the code and the documentation for the theano flags Update the code and the documentation for the theano flags
warn.ignore_bug_before to accept the new version. You must modify the ``warn.ignore_bug_before`` to accept the new version. You must modify the
file theano/configdefaults.py and doc/library/config.txt. file ``theano/configdefaults.py`` and ``doc/library/config.txt``.
Tag the release Tag the release
=============== ===============
...@@ -55,17 +57,19 @@ following:: ...@@ -55,17 +57,19 @@ following::
git commit -m "Modifications for 0.X.Y release" setup.py doc/conf.py NEWS.txt HISTORY.txt theano/configdefaults.py doc/library/config.txt git commit -m "Modifications for 0.X.Y release" setup.py doc/conf.py NEWS.txt HISTORY.txt theano/configdefaults.py doc/library/config.txt
git tag -a rel-0.X.Y git tag -a rel-0.X.Y
git push git push --tags
The documentation will be automatically regenerated in the next few hours. The documentation will be automatically regenerated in the next few hours.
Generate and upload the package Generate and upload the package
=============================== ===============================
For release candidates, only upload on PyPI.
On PyPI On PyPI
------- -------
Now change ``ISRELEASED`` in setup.py to ``True``. Now change ``ISRELEASED`` in ``setup.py`` to ``True``.
Finally, use setuptools to register and upload the release:: Finally, use setuptools to register and upload the release::
...@@ -75,6 +79,11 @@ This command register and uploads the package on pypi.python.org. To be able ...@@ -75,6 +79,11 @@ This command register and uploads the package on pypi.python.org. To be able
to do that, you must register on PyPI (you can create an new account, or use to do that, you must register on PyPI (you can create an new account, or use
OpenID), and be listed among the "Package Index Owners" of Theano. OpenID), and be listed among the "Package Index Owners" of Theano.
There is a bug in some versions of distutils that raises a
UnicodeDecodeError if there are non-ASCII characters in NEWS.txt. You
would need to change NEWS.txt so it contains only ASCII characters (the
problem usually comes from diacritics in people's names).
On freshmeat On freshmeat
------------ ------------
...@@ -126,3 +135,8 @@ from ``NEWS.txt``, and send it to the following mailing lists: ...@@ -126,3 +135,8 @@ from ``NEWS.txt``, and send it to the following mailing lists:
* theano-announce * theano-announce
* numpy-discussion@scipy.org * numpy-discussion@scipy.org
* scipy-user@scipy.org * scipy-user@scipy.org
For release candidates, only e-mail:
* theano-announce
* theano-dev
* theano-users
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论