diff options
Diffstat (limited to 'doc/intro.rst')
| -rw-r--r-- | doc/intro.rst | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/intro.rst b/doc/intro.rst index 4d052c81..dd541bf1 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -16,6 +16,10 @@ Though there is support for that kind of docs as well (which is intended to be freely mixed with hand-written content), if you need pure API docs have a look at `Epydoc <http://epydoc.sf.net/>`_, which also understands reST. +For a great "introduction" to writing docs in general -- the whys and hows, see +also `Write the docs <http://write-the-docs.readthedocs.org/>`_, written by Eric +Holscher. + Conversion from other systems ----------------------------- @@ -24,7 +28,7 @@ This section is intended to collect helpful hints for those wanting to migrate to reStructuredText/Sphinx from other documentation systems. * Gerard Flanagan has written a script to convert pure HTML to reST; it can be - found at the `Python Package Index <http://pypi.python.org/pypi/html2rest>`_. + found at the `Python Package Index <https://pypi.python.org/pypi/html2rest>`_. * For converting the old Python docs to Sphinx, a converter was written which can be found at `the Python SVN repository @@ -35,7 +39,7 @@ to reStructuredText/Sphinx from other documentation systems. markup; it is at `Google Code <http://code.google.com/p/db2rst/>`_. * Christophe de Vienne wrote a tool to convert from Open/LibreOffice documents - to Sphinx: `odt2sphinx <http://pypi.python.org/pypi/odt2sphinx/>`_. + to Sphinx: `odt2sphinx <https://pypi.python.org/pypi/odt2sphinx/>`_. * To convert different markups, `Pandoc <http://johnmacfarlane.net/pandoc/>`_ is a very helpful tool. @@ -50,7 +54,7 @@ See the :ref:`pertinent section in the FAQ list <usingwith>`. Prerequisites ------------- -Sphinx needs at least **Python 2.5** or **Python 3.1** to run, as well as the +Sphinx needs at least **Python 2.6** or **Python 3.2** to run, as well as the docutils_ and Jinja2_ libraries. Sphinx should work with docutils version 0.7 or some (not broken) SVN trunk snapshot. If you like to have source code highlighting support, you must also install the Pygments_ library. |