diff options
Diffstat (limited to 'doc/extdev')
| -rw-r--r-- | doc/extdev/index.rst | 1 | ||||
| -rw-r--r-- | doc/extdev/utils.rst | 19 |
2 files changed, 20 insertions, 0 deletions
diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 78414cd09..2dba7a430 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -94,6 +94,7 @@ APIs used for writing extensions nodes logging i18n + utils Deprecated APIs --------------- diff --git a/doc/extdev/utils.rst b/doc/extdev/utils.rst new file mode 100644 index 000000000..6ec3f1b46 --- /dev/null +++ b/doc/extdev/utils.rst @@ -0,0 +1,19 @@ +Utilities +========= + +Sphinx provides utility classes and functions to develop extensions. + +Base classes for components +--------------------------- + +These base classes are useful to allow your extensions to obtain Sphinx +components (e.g. :class:`.Config`, :class:`.BuildEnvironment` and so on) easily. + +.. note:: The subclasses of them might not work with bare docutils because they + are strongly coupled with Sphinx. + +.. autoclass:: sphinx.transforms.SphinxTransform + :members: + +.. autoclass:: sphinx.util.docutils.SphinxDirective + :members: |