2008-03-09 16:32:24 -05:00
|
|
|
.. _extensions:
|
|
|
|
|
|
|
|
|
|
Sphinx Extensions
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
.. module:: sphinx.application
|
|
|
|
|
:synopsis: Application class and extensibility interface.
|
|
|
|
|
|
|
|
|
|
Since many projects will need special features in their documentation, Sphinx is
|
|
|
|
|
designed to be extensible on several levels.
|
|
|
|
|
|
|
|
|
|
First, you can add new :term:`builder`\s to support new output formats or
|
|
|
|
|
actions on the parsed documents. Then, it is possible to register custom
|
|
|
|
|
reStructuredText roles and directives, extending the markup. And finally, there
|
|
|
|
|
are so-called "hook points" at strategic places throughout the build process,
|
|
|
|
|
where an extension can register a hook and run specialized code.
|
|
|
|
|
|
2008-03-12 16:37:22 -05:00
|
|
|
.. toctree::
|
2008-03-09 16:32:24 -05:00
|
|
|
|
2008-03-12 16:37:22 -05:00
|
|
|
ext/api.rst
|
2008-03-09 16:32:24 -05:00
|
|
|
|
|
|
|
|
|
2008-03-12 16:37:22 -05:00
|
|
|
Builtin Sphinx extensions
|
|
|
|
|
-------------------------
|
2008-03-09 16:32:24 -05:00
|
|
|
|
2008-03-12 16:37:22 -05:00
|
|
|
These extensions are built in and can be activated by respective entries in the
|
|
|
|
|
:confval:`extensions` configuration value:
|
2008-03-09 16:32:24 -05:00
|
|
|
|
2008-03-12 16:37:22 -05:00
|
|
|
.. toctree::
|
2008-03-09 16:32:24 -05:00
|
|
|
|
2008-03-12 16:37:22 -05:00
|
|
|
ext/autodoc.rst
|
|
|
|
|
ext/doctest.rst
|
|
|
|
|
ext/refcounting.rst
|
|
|
|
|
ext/ifconfig.rst
|
|
|
|
|
ext/coverage.rst
|
