From a0b76ae6ff5f50a959100d45262c81dac2dbdf56 Mon Sep 17 00:00:00 2001 From: Niko W Date: Sat, 12 May 2012 20:54:40 +0200 Subject: [PATCH 1/3] Added paragraph about Epydoc. --- docs/writing/documentation.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst index c4cb0fd..0ff0a60 100644 --- a/docs/writing/documentation.rst +++ b/docs/writing/documentation.rst @@ -220,8 +220,14 @@ should help you familiarize yourself with its syntax. Other Tools ::::::::::: -that old thing --------------- +Epydoc +------ +Epydoc generates API documentation based on docstrings. +Epydoc is able to parse docstrings marked up with reStructuredText, Javadoc, +plaintext or epytext. It supports various output formats, most notable HTML, +PDF or LaTeX documents. + +The development of Epydoc is discontinued. You should use Sphinx instead. pycco / docco / shocco ---------------------- From 89f9147aec5ad5b0bb62fbaec76e5ca14cf383df Mon Sep 17 00:00:00 2001 From: Niko Wenselowski Date: Sat, 12 May 2012 22:00:46 +0200 Subject: [PATCH 2/3] Added document ref to Sphinx. Inserted links at the Epydoc text. --- docs/writing/documentation.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst index 0ff0a60..514197a 100644 --- a/docs/writing/documentation.rst +++ b/docs/writing/documentation.rst @@ -193,6 +193,10 @@ Multi-line docstrings: :: if imag == 0.0 and real == 0.0: return complex_zero ... + +.. _sphinx-ref: + + Sphinx ------ @@ -220,14 +224,16 @@ should help you familiarize yourself with its syntax. Other Tools ::::::::::: + Epydoc ------ -Epydoc generates API documentation based on docstrings. -Epydoc is able to parse docstrings marked up with reStructuredText, Javadoc, -plaintext or epytext. It supports various output formats, most notable HTML, -PDF or LaTeX documents. +`Epydoc `_ generates API documentation based on docstrings. +Epydoc is able to parse docstrings marked up with :ref:`reStructuredText-ref`, +`Javadoc `_, +`epytext `_ or plaintext. +It supports various output formats, most notable HTML, PDF or LaTeX documents. -The development of Epydoc is discontinued. You should use Sphinx instead. +The development of Epydoc is discontinued. You should use :ref:`sphinx-ref` instead. pycco / docco / shocco ---------------------- From 23370fa83a44c880b3b004982f1825faee9add62 Mon Sep 17 00:00:00 2001 From: Niko Wenselowski Date: Sat, 12 May 2012 22:05:31 +0200 Subject: [PATCH 3/3] Make the inline link to docstrings work. --- docs/writing/documentation.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst index 514197a..e469439 100644 --- a/docs/writing/documentation.rst +++ b/docs/writing/documentation.rst @@ -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.