File tree Expand file tree Collapse file tree 1 file changed +11
-5
lines changed
Filter options
Expand file tree Collapse file tree 1 file changed +11
-5
lines changed
Original file line number Diff line number Diff line change @@ -193,6 +193,10 @@ Multi-line docstrings: ::
193
193
if imag == 0.0 and real == 0.0: return complex_zero
194
194
...
195
195
196
+
197
+ .. _sphinx-ref :
198
+
199
+
196
200
Sphinx
197
201
------
198
202
@@ -220,14 +224,16 @@ should help you familiarize yourself with its syntax.
220
224
Other Tools
221
225
:::::::::::
222
226
227
+
223
228
Epydoc
224
229
------
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.
229
235
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.
231
237
232
238
pycco / docco / shocco
233
239
----------------------
You can’t perform that action at this time.
0 commit comments