File tree Expand file tree Collapse file tree 1 file changed +16
-2
lines changed
Filter options
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
55
55
Comments are written directly inside the code, either using the hash sign (#)
56
56
or a docstring _.
57
57
58
+ .. _docstring : docstrings _
59
+
58
60
Finding the correct balance between undocumented code and verbose and useless
59
61
comment boilerplates is difficult, and is the subject of heated discussion
60
62
among developers.
@@ -193,6 +195,10 @@ Multi-line docstrings: ::
193
195
if imag == 0.0 and real == 0.0: return complex_zero
194
196
...
195
197
198
+
199
+ .. _sphinx-ref :
200
+
201
+
196
202
Sphinx
197
203
------
198
204
@@ -220,8 +226,16 @@ should help you familiarize yourself with its syntax.
220
226
Other Tools
221
227
:::::::::::
222
228
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.
225
239
226
240
pycco / docco / shocco
227
241
----------------------
You can’t perform that action at this time.
0 commit comments