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

Add link to docutils directive docs.

Browse Source
This commit is contained in:
Georg Brandl 2009-02-18 00:13:12 +01:00
parent 632a2f0fd6
commit 8777c34779
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/ext/appapi.rst
View File

@ -68,13 +68,14 @@ the following public API:
* In the docutils 0.4 style, *func* is the directive function. *content*, * In the docutils 0.4 style, *func* is the directive function. *content*,
*arguments* and *options* are set as attributes on the function and *arguments* and *options* are set as attributes on the function and
determine whether the directive has content, arguments and options, determine whether the directive has content, arguments and options,
respectively. For their exact meaning, please consult the Docutils respectively.
documentation.
* In the docutils 0.5 style, *directiveclass* is the directive class. It * In the docutils 0.5 style, *directiveclass* is the directive class. It
must already have attributes named *has_content*, *required_arguments*, must already have attributes named *has_content*, *required_arguments*,
*optional_arguments*, *final_argument_whitespace* and *option_spec* that *optional_arguments*, *final_argument_whitespace* and *option_spec* that
correspond to the options for the function way. correspond to the options for the function way. See `the Docutils docs
<http://docutils.sourceforge.net/docs/howto/rst-directives.html>`_ for
details.
The directive class normally must inherit from the class The directive class normally must inherit from the class
``docutils.parsers.rst.Directive``. When writing a directive for usage in ``docutils.parsers.rst.Directive``. When writing a directive for usage in