2018-03-30 08:39:25 -05:00
|
|
|
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:
|
|
|
|
|
|
2019-03-17 04:27:00 -05:00
|
|
|
.. autoclass:: sphinx.transforms.post_transforms.SphinxPostTransform
|
|
|
|
|
:members:
|
|
|
|
|
|
2018-03-30 08:39:25 -05:00
|
|
|
.. autoclass:: sphinx.util.docutils.SphinxDirective
|
|
|
|
|
:members:
|
2018-04-12 09:02:18 -05:00
|
|
|
|
2019-02-15 10:10:51 -06:00
|
|
|
.. autoclass:: sphinx.util.docutils.SphinxRole
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: sphinx.util.docutils.ReferenceRole
|
|
|
|
|
:members:
|
|
|
|
|
|
2018-04-12 09:02:18 -05:00
|
|
|
.. autoclass:: sphinx.transforms.post_transforms.images.ImageConverter
|
|
|
|
|
:members:
|
2019-03-09 01:46:41 -06:00
|
|
|
|
|
|
|
|
Utility components
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: sphinx.events.EventManager
|
|
|
|
|
:members:
|
