Skip to content

Extending documentation tools: Epydoc #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kennethreitz merged 3 commits into from
May 12, 2012
Merged

Extending documentation tools: Epydoc #148

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0b76ae
Added paragraph about Epydoc.
okin May 12, 2012
89f9147
Added document ref to Sphinx. Inserted links at the Epydoc text.
okin May 12, 2012
23370fa
Make the inline link to docstrings work.
okin May 12, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions docs/writing/documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ Comments
Comments are written directly inside the code, either using the hash sign (#)
or a docstring_.

.. _docstring: docstrings_

Finding the correct balance between undocumented code and verbose and useless
comment boilerplates is difficult, and is the subject of heated discussion
among developers.
Expand Down Expand Up @@ -193,6 +195,10 @@ Multi-line docstrings: ::
if imag == 0.0 and real == 0.0: return complex_zero
...


.. _sphinx-ref:


Sphinx
------

Expand Down Expand Up @@ -220,8 +226,16 @@ should help you familiarize yourself with its syntax.
Other Tools
:::::::::::

that old thing
--------------

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

The development of Epydoc is discontinued. You should use :ref:`sphinx-ref` instead.

pycco / docco / shocco
----------------------
Expand Down