提交 7bbb1d0d authored 作者: Pascal Lamblin's avatar Pascal Lamblin

Move scripts directory into doc/scripts

上级 1f1f569b
...@@ -54,7 +54,7 @@ on your system: ...@@ -54,7 +54,7 @@ on your system:
.. revision ? .. revision ?
.. code-block:: bash .. code-block:: bash
easy_install http://pylearn.org/hg/theano/archive/tip.tar.gz easy_install http://pylearn.org/hg/theano/archive/tip.tar.gz
.. TODO: make sure this works .. TODO: make sure this works
...@@ -76,7 +76,7 @@ no stable releases yet. ...@@ -76,7 +76,7 @@ no stable releases yet.
Get the source and run the tests like this: Get the source and run the tests like this:
.. code-block:: bash .. code-block:: bash
hg clone http://pylearn.org/hg/theano Theano hg clone http://pylearn.org/hg/theano Theano
ln -s Theano/theano <someplace on your PYTHONPATH>/theano ln -s Theano/theano <someplace on your PYTHONPATH>/theano
cd Theano cd Theano
...@@ -175,8 +175,8 @@ This should give you the gist of it: ...@@ -175,8 +175,8 @@ This should give you the gist of it:
.. code-block:: bash .. code-block:: bash
$ python scripts/docgen.py --help $ python doc/scripts/docgen.py --help
Usage: scripts/docgen.py [OPTIONS] Usage: doc/scripts/docgen.py [OPTIONS]
-o <dir>: output the html files in the specified dir -o <dir>: output the html files in the specified dir
--rst: only compile the doc (requires sphinx) --rst: only compile the doc (requires sphinx)
--epydoc: only compile the api documentation (requires epydoc) --epydoc: only compile the api documentation (requires epydoc)
......
...@@ -25,7 +25,7 @@ If you are lazy, you can try:: ...@@ -25,7 +25,7 @@ If you are lazy, you can try::
However, if the link target is ambiguous, Sphinx will generate errors. However, if the link target is ambiguous, Sphinx will generate errors.
NB the ``:api:`` reference is special magic by Olivier, in NB the ``:api:`` reference is special magic by Olivier, in
./scripts/docgen.py. ./doc/scripts/docgen.py.
How to add TODO comments in Sphinx documentation How to add TODO comments in Sphinx documentation
------------------------------------------------- -------------------------------------------------
...@@ -61,12 +61,12 @@ the `epydoc <http://epydoc.sourceforge.net/>`__ and `sphinx ...@@ -61,12 +61,12 @@ the `epydoc <http://epydoc.sourceforge.net/>`__ and `sphinx
The following technique uses Olivier's code to insert :api: links:: The following technique uses Olivier's code to insert :api: links::
cd Theano/ cd Theano/
python ./scripts/docgen.py python ./doc/scripts/docgen.py
If you don't want to rerun epydoc, do the following:: If you don't want to rerun epydoc, do the following::
cd Theano/ cd Theano/
python ./scripts/docgen.py --rst python ./doc/scripts/docgen.py --rst
...@@ -105,5 +105,5 @@ TO WRITE ...@@ -105,5 +105,5 @@ TO WRITE
* where the documentation is getting built, and epy. * where the documentation is getting built, and epy.
* How epydoc and sphinx are integrated * How epydoc and sphinx are integrated
* The nightly build process. * The nightly build process.
* Explain the special magic in ./scripts/docgen.py * Explain the special magic in ./doc/scripts/docgen.py
* We also want examples of good documentation, to show people how to write sphinx, * We also want examples of good documentation, to show people how to write sphinx,
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论