mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
1cfb68d8be
* The directive option ``:noindex:`` was renamed to ``:no-index:``. * The directive option ``:noindexentry:`` was renamed to ``:no-index-entry:``. * The directive option ``:nocontentsentry:`` was renamed to ``:no-contents-entry:``. The previous names are retained as aliases, but will be deprecated and removed in a future version of Sphinx (9.0 or later).
33 lines
1.0 KiB
ReStructuredText
33 lines
1.0 KiB
ReStructuredText
Developing extensions overview
|
|
==============================
|
|
|
|
This page contains general information about developing Sphinx extensions.
|
|
|
|
Make an extension depend on another extension
|
|
---------------------------------------------
|
|
|
|
Sometimes your extension depends on the functionality of another
|
|
Sphinx extension. Most Sphinx extensions are activated in a
|
|
project's :file:`conf.py` file, but this is not available to you as an
|
|
extension developer.
|
|
|
|
.. module:: sphinx.application
|
|
:no-index:
|
|
|
|
To ensure that another extension is activated as a part of your own extension,
|
|
use the :meth:`sphinx.application.Sphinx.setup_extension` method. This will
|
|
activate another extension at run-time, ensuring that you have access to its
|
|
functionality.
|
|
|
|
For example, the following code activates the ``recommonmark`` extension:
|
|
|
|
.. code-block:: python
|
|
|
|
def setup(app):
|
|
app.setup_extension("recommonmark")
|
|
|
|
.. note::
|
|
|
|
Since your extension will depend on another, make sure to include
|
|
it as a part of your extension's installation requirements.
|