Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 18b8e12

Browse filesBrowse files
author
Kenneth Reitz
committed
Merge pull request #148 from okin/master
Extending documentation tools: Epydoc
2 parents a8b764e + 23370fa commit 18b8e12
Copy full SHA for 18b8e12

File tree

Expand file treeCollapse file tree

1 file changed

+16
-2
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+16
-2
lines changed

‎docs/writing/documentation.rst

Copy file name to clipboardExpand all lines: docs/writing/documentation.rst
+16-2Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ Comments
5555
Comments are written directly inside the code, either using the hash sign (#)
5656
or a docstring_.
5757

58+
.. _docstring: docstrings_
59+
5860
Finding the correct balance between undocumented code and verbose and useless
5961
comment boilerplates is difficult, and is the subject of heated discussion
6062
among 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+
196202
Sphinx
197203
------
198204

@@ -220,8 +226,16 @@ should help you familiarize yourself with its syntax.
220226
Other 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

226240
pycco / docco / shocco
227241
----------------------

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.