Documentation reshuffle (#11112)

This commit is contained in:
Adam Turner 2023-01-08 13:52:36 +00:00 committed by GitHub
parent 67291f414e
commit 670bcb743b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 14 additions and 10 deletions

View File

@ -6,4 +6,4 @@
Sphinx authors
==============
.. include:: ../../AUTHORS
.. include:: ../AUTHORS

View File

@ -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

View File

@ -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:

View File

@ -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.

View File

@ -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

View File

@ -13,4 +13,3 @@ how to contribute to the project.
release-process
organization
code-of-conduct
authors

View File

@ -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`.

View File

@ -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