Skip to content
Browse files

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

  • Loading branch information...
1 parent a0b76ae commit 89f9147aec5ad5b0bb62fbaec76e5ca14cf383df @okin okin committed May 12, 2012
Showing with 11 additions and 5 deletions.
  1. +11 −5 docs/writing/documentation.rst
View
16 docs/writing/documentation.rst
@@ -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
----------------------

0 comments on commit 89f9147

Please sign in to comment.
Something went wrong with that request. Please try again.