Skip to content

Commit 89f9147

Browse files
committed
Added document ref to Sphinx. Inserted links at the Epydoc text.
1 parent a0b76ae commit 89f9147

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/writing/documentation.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,10 @@ Multi-line docstrings: ::
193193
if imag == 0.0 and real == 0.0: return complex_zero
194194
...
195195

196+
197+
.. _sphinx-ref:
198+
199+
196200
Sphinx
197201
------
198202

@@ -220,14 +224,16 @@ should help you familiarize yourself with its syntax.
220224
Other Tools
221225
:::::::::::
222226

227+
223228
Epydoc
224229
------
225-
Epydoc generates API documentation based on docstrings.
226-
Epydoc is able to parse docstrings marked up with reStructuredText, Javadoc,
227-
plaintext or epytext. It supports various output formats, most notable HTML,
228-
PDF or LaTeX documents.
230+
`Epydoc <http://epydoc.sourceforge.net/>`_ generates API documentation based on docstrings.
231+
Epydoc is able to parse docstrings marked up with :ref:`reStructuredText-ref`,
232+
`Javadoc <http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html#javadocdocuments>`_,
233+
`epytext <http://epydoc.sourceforge.net/manual-epytext.html>`_ or plaintext.
234+
It supports various output formats, most notable HTML, PDF or LaTeX documents.
229235

230-
The development of Epydoc is discontinued. You should use Sphinx instead.
236+
The development of Epydoc is discontinued. You should use :ref:`sphinx-ref` instead.
231237

232238
pycco / docco / shocco
233239
----------------------

0 commit comments

Comments
 (0)