kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Niko Wenselowski
2012-05-12 22:00:46 +02:00
parent a0b76ae6ff
commit 89f9147aec
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/documentation.rst
+11 -5
View File
@@ -193,6 +193,10 @@ Multi-line docstrings: ::
if imag == 0.0 and real == 0.0: return complex_zero if imag == 0.0 and real == 0.0: return complex_zero
... ...
.. _sphinx-ref:
Sphinx Sphinx
------ ------
@@ -220,14 +224,16 @@ should help you familiarize yourself with its syntax.
Other Tools Other Tools
::::::::::: :::::::::::
Epydoc Epydoc
------ ------
Epydoc generates API documentation based on docstrings. `Epydoc <http://epydoc.sourceforge.net/>`_ generates API documentation based on docstrings.
Epydoc is able to parse docstrings marked up with reStructuredText, Javadoc, Epydoc is able to parse docstrings marked up with :ref:`reStructuredText-ref`,
plaintext or epytext. It supports various output formats, most notable HTML, `Javadoc <http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html#javadocdocuments>`_,
PDF or LaTeX documents. `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 pycco / docco / shocco
---------------------- ----------------------