File tree Expand file tree Collapse file tree 1 file changed +16
-2
lines changed
Expand file tree Collapse file tree 1 file changed +16
-2
lines changed Original file line number Diff line number Diff line change @@ -55,6 +55,8 @@ Comments
5555Comments are written directly inside the code, either using the hash sign (#)
5656or a docstring _.
5757
58+ .. _docstring : docstrings _
59+
5860Finding the correct balance between undocumented code and verbose and useless
5961comment boilerplates is difficult, and is the subject of heated discussion
6062among developers.
@@ -193,6 +195,10 @@ Multi-line docstrings: ::
193195 if imag == 0.0 and real == 0.0: return complex_zero
194196 ...
195197
198+
199+ .. _sphinx-ref :
200+
201+
196202Sphinx
197203------
198204
@@ -220,8 +226,16 @@ should help you familiarize yourself with its syntax.
220226Other Tools
221227:::::::::::
222228
223- that old thing
224- --------------
229+
230+ Epydoc
231+ ------
232+ `Epydoc <http://epydoc.sourceforge.net/ >`_ generates API documentation based on docstrings.
233+ Epydoc is able to parse docstrings marked up with :ref: `reStructuredText-ref `,
234+ `Javadoc <http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html#javadocdocuments >`_,
235+ `epytext <http://epydoc.sourceforge.net/manual-epytext.html >`_ or plaintext.
236+ It supports various output formats, most notable HTML, PDF or LaTeX documents.
237+
238+ The development of Epydoc is discontinued. You should use :ref: `sphinx-ref ` instead.
225239
226240pycco / docco / shocco
227241----------------------
You can’t perform that action at this time.
0 commit comments