提交 5438f37b authored 作者: Joseph Turian's avatar Joseph Turian

Updated internal docs RE reST for epydoc

上级 ba8ade1b
...@@ -5,11 +5,20 @@ Internal notes ...@@ -5,11 +5,20 @@ Internal notes
================ ================
How to write API documentation
---------------------------------------
API documentation is processed by `epydoc
<http://epydoc.sourceforge.net/>`__ and should be written in
`reStructuredText <http://docutils.sourceforge.net/rst.html>`__. See `here
<http://epydoc.sourceforge.net/manual-othermarkup.html#restructuredtext>`__
for details about how to use reST with epydoc documentation.
How to build sphinx documentation How to build sphinx documentation
--------------------------------------- ---------------------------------------
Let's say you are writing documentation, and want to see the sphinx Let's say you are writing documentation, and want to see the `sphinx
output before you push it. <http://sphinx.pocoo.org/>`__ output before you push it.
Here is what you do it:: Here is what you do it::
cd Theano/doc cd Theano/doc
...@@ -38,7 +47,7 @@ pylint ...@@ -38,7 +47,7 @@ pylint
--------------------------------------- ---------------------------------------
Here is the autogenerated `pylint output Here is the autogenerated `pylint output
<http://lgcm.iro.umontreal.ca/auto_theano_pylint/pylint_global.html>`. <http://pylearn.org/auto_theano_pylint/pylint_global.html>`__.
Pylint documentation is generated using pylintrc file: ``Theano/doc/pylintrc`` Pylint documentation is generated using pylintrc file: ``Theano/doc/pylintrc``
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论