From 89f9147aec5ad5b0bb62fbaec76e5ca14cf383df Mon Sep 17 00:00:00 2001 From: Niko Wenselowski Date: Sat, 12 May 2012 22:00:46 +0200 Subject: [PATCH] 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 ----------------------