diff options
| -rw-r--r-- | doc/authors.rst (renamed from doc/internals/authors.rst) | 2 | ||||
| -rw-r--r-- | doc/development/index.rst | 7 | ||||
| -rw-r--r-- | doc/development/templating.rst (renamed from doc/templating.rst) | 0 | ||||
| -rw-r--r-- | doc/development/theming.rst | 2 | ||||
| -rw-r--r-- | doc/extdev/index.rst | 4 | ||||
| -rw-r--r-- | doc/index.rst | 5 | ||||
| -rw-r--r-- | doc/internals/index.rst | 1 | ||||
| -rw-r--r-- | doc/internals/organization.rst | 2 | ||||
| -rw-r--r-- | doc/usage/extensions/index.rst | 1 |
9 files changed, 14 insertions, 10 deletions
diff --git a/doc/internals/authors.rst b/doc/authors.rst index 929acc935..411835bc1 100644 --- a/doc/internals/authors.rst +++ b/doc/authors.rst @@ -6,4 +6,4 @@ Sphinx authors ============== -.. include:: ../../AUTHORS +.. include:: ../AUTHORS diff --git a/doc/development/index.rst b/doc/development/index.rst index 8ae71e76f..55a31a0c1 100644 --- a/doc/development/index.rst +++ b/doc/development/index.rst @@ -1,6 +1,6 @@ -================ -Extending Sphinx -================ +========================= +Writing Sphinx Extensions +========================= This guide is aimed at giving a quick introduction for those wishing to develop their own extensions for Sphinx. Sphinx possesses significant @@ -20,4 +20,5 @@ the extension interface see :doc:`/extdev/index`. :caption: Theming :maxdepth: 2 + templating theming diff --git a/doc/templating.rst b/doc/development/templating.rst index c33007604..c33007604 100644 --- a/doc/templating.rst +++ b/doc/development/templating.rst diff --git a/doc/development/theming.rst b/doc/development/theming.rst index a8de10930..abe03d59a 100644 --- a/doc/development/theming.rst +++ b/doc/development/theming.rst @@ -131,7 +131,7 @@ If your theme package contains two or more themes, please call Templating ---------- -The :doc:`guide to templating </templating>` is helpful if you want to write your +The :doc:`guide to templating <templating>` is helpful if you want to write your own templates. What is important to keep in mind is the order in which Sphinx searches for templates: diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 014a806e5..8332315ff 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -1,7 +1,7 @@ .. _dev-extensions: -Developing extensions for Sphinx -================================ +Sphinx Extensions API +===================== Since many projects will need special features in their documentation, Sphinx is designed to be extensible on several levels. diff --git a/doc/index.rst b/doc/index.rst index e795bdb57..e9aea1c60 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -75,7 +75,6 @@ starting with :ref:`get-started`. usage/index development/index - templating latex extdev/index @@ -96,6 +95,7 @@ like to contribute to the project. support internals/index faq + authors Reference guide =============== @@ -109,6 +109,9 @@ usecase-driven documentation, see :ref:`get-started` or :ref:`user-guides`. :caption: Reference man/index + usage/configuration + usage/extensions/index + usage/restructuredtext/index glossary changes examples diff --git a/doc/internals/index.rst b/doc/internals/index.rst index c52f32a67..187082ec9 100644 --- a/doc/internals/index.rst +++ b/doc/internals/index.rst @@ -13,4 +13,3 @@ how to contribute to the project. release-process organization code-of-conduct - authors diff --git a/doc/internals/organization.rst b/doc/internals/organization.rst index 4fc159845..9dec9231b 100644 --- a/doc/internals/organization.rst +++ b/doc/internals/organization.rst @@ -53,4 +53,4 @@ documentation improvements. More information can be found in :doc:`contributing`. A list of people that have contributed to Sphinx can be found in -:doc:`authors`. +:doc:`../authors`. diff --git a/doc/usage/extensions/index.rst b/doc/usage/extensions/index.rst index 37d71c503..e81c805d6 100644 --- a/doc/usage/extensions/index.rst +++ b/doc/usage/extensions/index.rst @@ -19,6 +19,7 @@ These extensions are built in and can be activated by respective entries in the :confval:`extensions` configuration value: .. toctree:: + :maxdepth: 1 autodoc autosectionlabel |