mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
docs: Add usage, development index page
Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
parent
9988d5ce26
commit
f07ad49c22
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
.. _contents:
|
.. _contents:
|
||||||
|
|
||||||
Sphinx documentation contents
|
Sphinx documentation contents
|
||||||
@ -9,24 +8,14 @@ Sphinx documentation contents
|
|||||||
|
|
||||||
intro
|
intro
|
||||||
|
|
||||||
usage/installation
|
usage/index
|
||||||
usage/quickstart
|
development/index
|
||||||
usage/restructuredtext/index
|
|
||||||
usage/markdown
|
|
||||||
usage/configuration
|
|
||||||
usage/builders/index
|
|
||||||
usage/extensions/index
|
|
||||||
usage/theming
|
|
||||||
usage/advanced/intl
|
|
||||||
usage/advanced/setuptools
|
|
||||||
usage/advanced/websupport/index
|
|
||||||
|
|
||||||
man/index
|
man/index
|
||||||
|
|
||||||
theming
|
theming
|
||||||
templating
|
templating
|
||||||
latex
|
latex
|
||||||
extdev/index
|
extdev/index
|
||||||
development/tutorials/index
|
|
||||||
|
|
||||||
faq
|
faq
|
||||||
glossary
|
glossary
|
||||||
|
13
doc/development/index.rst
Normal file
13
doc/development/index.rst
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
================
|
||||||
|
Extending Sphinx
|
||||||
|
================
|
||||||
|
|
||||||
|
This guide is aimed at those wishing to develop their own extensions for
|
||||||
|
Sphinx. Sphinx possesses significant extensibility capabilities including the
|
||||||
|
ability to hook into almost every point of the build process. If you simply
|
||||||
|
wish to use Sphinx with existing extensions, refer to :doc:`/usage/index`.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
tutorials/index
|
23
doc/usage/index.rst
Normal file
23
doc/usage/index.rst
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
============
|
||||||
|
Using Sphinx
|
||||||
|
============
|
||||||
|
|
||||||
|
This guide serves to demonstrate how one can get started with Sphinx and covers
|
||||||
|
everything from installing Sphinx and configuring your first Sphinx project to
|
||||||
|
using some of the advanced features Sphinx provides out-of-the-box. If you are
|
||||||
|
looking for guidance on extending Sphinx, refer to :doc:`/development/index`.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
quickstart
|
||||||
|
installation
|
||||||
|
restructuredtext/index
|
||||||
|
markdown
|
||||||
|
configuration
|
||||||
|
builders/index
|
||||||
|
extensions/index
|
||||||
|
theming
|
||||||
|
advanced/intl
|
||||||
|
advanced/setuptools
|
||||||
|
advanced/websupport/index
|
Loading…
Reference in New Issue
Block a user