some directive creation docs

This commit is contained in:
Georg Brandl
2014-01-21 10:32:30 +01:00
parent 6b33e3fea4
commit fb5a1a09a0
2 changed files with 133 additions and 5 deletions

View File

@@ -225,10 +225,10 @@ The Directive Classes
---------------------
A directive class is a class deriving usually from
``docutils.parsers.rst.Directive``. The directive interface is covered in
detail in the `docutils documentation`_; the important thing is that the class
has attributes that configure the allowed markup and a method ``run`` that
returns a list of nodes.
:class:`docutils.parsers.rst.Directive`. The directive interface is also
covered in detail in the `docutils documentation`_; the important thing is that
the class has attributes that configure the allowed markup and a method ``run``
that returns a list of nodes.
The ``todolist`` directive is quite simple::