summaryrefslogtreecommitdiff
path: root/doc/extdev/utils.rst
blob: 6ec3f1b468dc9d7c1e2702be5d9d2d926e0d004e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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: