mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
d59b158371
This type alias has now been fully documented for public consumption. This will be beneficial to the sphinx ecosystem, to aide/encourage extension developers to provide the correct metadata. Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
44 lines
1.0 KiB
ReStructuredText
44 lines
1.0 KiB
ReStructuredText
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.transforms.post_transforms.SphinxPostTransform
|
|
:members:
|
|
|
|
.. autoclass:: sphinx.util.docutils.SphinxDirective
|
|
:members:
|
|
|
|
.. autoclass:: sphinx.util.docutils.SphinxRole
|
|
:members:
|
|
|
|
.. autoclass:: sphinx.util.docutils.ReferenceRole
|
|
:members:
|
|
|
|
.. autoclass:: sphinx.transforms.post_transforms.images.ImageConverter
|
|
:members:
|
|
|
|
Utility components
|
|
------------------
|
|
|
|
.. autoclass:: sphinx.events.EventManager
|
|
:members:
|
|
|
|
Utility types
|
|
-------------
|
|
|
|
.. autoclass:: sphinx.util.typing.ExtensionMetadata
|
|
:members:
|