mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Documentation reshuffle (#11112)
This commit is contained in:
parent
67291f414e
commit
670bcb743b
@ -6,4 +6,4 @@
|
||||
Sphinx authors
|
||||
==============
|
||||
|
||||
.. include:: ../../AUTHORS
|
||||
.. include:: ../AUTHORS
|
@ -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
|
||||
|
@ -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:
|
||||
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -13,4 +13,3 @@ how to contribute to the project.
|
||||
release-process
|
||||
organization
|
||||
code-of-conduct
|
||||
authors
|
||||
|
@ -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`.
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user