IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Closes #793: Fix docutils version references.

Browse Source
This commit is contained in:
Georg Brandl 2011-11-01 09:16:37 +01:00
parent fd56b7c44a
commit 53d06fda7b
2 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/ext/appapi.rst
View File

@ -115,11 +115,8 @@ the following public API:
<http://docutils.sourceforge.net/docs/howto/rst-directives.html>`_ for <http://docutils.sourceforge.net/docs/howto/rst-directives.html>`_ for
details. details.
The directive class normally must inherit from the class The directive class must inherit from the class
``docutils.parsers.rst.Directive``. When writing a directive for usage in ``docutils.parsers.rst.Directive``.
a Sphinx extension, you inherit from ``sphinx.util.compat.Directive``
instead which does the right thing even on docutils 0.4 (which doesn't
support directive classes otherwise).
For example, the (already existing) :rst:dir:`literalinclude` directive would be For example, the (already existing) :rst:dir:`literalinclude` directive would be
added like this: added like this:

2
doc/intro.rst
View File

@ -51,7 +51,7 @@ Prerequisites
------------- -------------
Sphinx needs at least **Python 2.4** or **Python 3.1** to run, as well as the Sphinx needs at least **Python 2.4** or **Python 3.1** to run, as well as the
docutils_ and Jinja2_ libraries. Sphinx should work with docutils version 0.5 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 or some (not broken) SVN trunk snapshot. If you like to have source code
highlighting support, you must also install the Pygments_ library. highlighting support, you must also install the Pygments_ library.