diff options
| author | Chris Holdgraf <choldgraf@berkeley.edu> | 2020-07-28 17:59:55 -0700 |
|---|---|---|
| committer | Stephen Finucane <stephenfinucane@hotmail.com> | 2020-07-29 10:38:18 +0100 |
| commit | b8ee3ac9a45420ca4fbd56fd1975647fdff8d650 (patch) | |
| tree | 259b3f4d56a8af9b9cc21a7c8fc7a0d2f47b3151 /doc/development/tutorials | |
| parent | 84f7dffd995fa36f5380e4b79a681c62fd3a0296 (diff) | |
| download | sphinx-git-b8ee3ac9a45420ca4fbd56fd1975647fdff8d650.tar.gz | |
moving extension dev overview
Diffstat (limited to 'doc/development/tutorials')
| -rw-r--r-- | doc/development/tutorials/index.rst | 4 | ||||
| -rw-r--r-- | doc/development/tutorials/overview.rst | 32 |
2 files changed, 0 insertions, 36 deletions
diff --git a/doc/development/tutorials/index.rst b/doc/development/tutorials/index.rst index 3b625090d..be126b3ca 100644 --- a/doc/development/tutorials/index.rst +++ b/doc/development/tutorials/index.rst @@ -5,10 +5,6 @@ Extension tutorials Refer to the following tutorials to get started with extension development. -.. toctree:: - :caption: General extension tutorials - - overview .. toctree:: :caption: Directive tutorials diff --git a/doc/development/tutorials/overview.rst b/doc/development/tutorials/overview.rst deleted file mode 100644 index ad474999a..000000000 --- a/doc/development/tutorials/overview.rst +++ /dev/null @@ -1,32 +0,0 @@ -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 - :noindex: - -To ensure that another extension is activated as a part of your own extension, -use the :meth:`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. |
