Added document ref to Sphinx. Inserted links at the Epydoc text.

This commit is contained in:
Niko Wenselowski
2012-05-12 22:00:46 +02:00
parent a0b76ae6ff
commit 89f9147aec
+11 -5
View File
@@ -193,6 +193,10 @@ Multi-line docstrings: ::
if imag == 0.0 and real == 0.0: return complex_zero
...
.. _sphinx-ref:
Sphinx
------
@@ -220,14 +224,16 @@ should help you familiarize yourself with its syntax.
Other Tools
:::::::::::
Epydoc
------
Epydoc generates API documentation based on docstrings.
Epydoc is able to parse docstrings marked up with reStructuredText, Javadoc,
plaintext or epytext. It supports various output formats, most notable HTML,
PDF or LaTeX documents.
`Epydoc <http://epydoc.sourceforge.net/>`_ generates API documentation based on docstrings.
Epydoc is able to parse docstrings marked up with :ref:`reStructuredText-ref`,
`Javadoc <http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html#javadocdocuments>`_,
`epytext <http://epydoc.sourceforge.net/manual-epytext.html>`_ or plaintext.
It supports various output formats, most notable HTML, PDF or LaTeX documents.
The development of Epydoc is discontinued. You should use Sphinx instead.
The development of Epydoc is discontinued. You should use :ref:`sphinx-ref` instead.
pycco / docco / shocco
----------------------