Update docs to use Sphinx 1.3 style captions

front-end-standardization
Eric Holscher 2015-05-04 15:00:39 -07:00
parent fd0e78b168
commit 73105ff625
2 changed files with 57 additions and 69 deletions

View File

@ -12,7 +12,7 @@ The largest feature that is different is that documentation on readthedocs.com i
If you have private code that you want documentation for,
this is our solution.
.. toctree:: Contents
.. toctree::
organizations
sharing

View File

@ -22,7 +22,7 @@ The code is open source, and `available on github`_.
The main documentation for the site is organized into a couple sections:
* :ref:`site-docs`
* :ref:`user-docs`
* :ref:`feature-docs`
* :ref:`about-docs`
@ -32,101 +32,89 @@ Information about development is also available:
* :ref:`design-docs`
* :ref:`ops-docs`
.. _site-docs:
User Documentation
------------------
.. _user-docs:
.. toctree::
:maxdepth: 2
:maxdepth: 2
:caption: User Documentation
getting_started
versions
builds
features
support
faq
getting_started
versions
builds
features
support
faq
.. _feature-docs:
Features
~~~~~~~~
.. toctree::
:maxdepth: 2
:glob:
:maxdepth: 2
:glob:
:caption: Feature Documentation
webhooks
badges
alternate_domains
localization
vcs
canonical
redirects
single_version
privacy
features/*
webhooks
badges
alternate_domains
localization
vcs
canonical
single_version
privacy
user-defined-redirects
automatic-redirects
features/*
.. _business-docs:
Business Documentation
----------------------
.. toctree::
:maxdepth: 2
business/index
.. _dev-docs:
Developer Documentation
-----------------------
.. toctree::
:maxdepth: 2
:caption: Developer Documentation
install
contribute
tests
architecture
symlinks
settings
i18n
api
.. _business-docs:
.. toctree::
:maxdepth: 2
:maxdepth: 2
:caption: Business Documentation
business/index
install
contribute
tests
architecture
symlinks
settings
i18n
api
api/index
.. _design-docs:
Designer Documentation
----------------------
.. toctree::
:maxdepth: 2
:maxdepth: 2
:caption: Designer Documentation
design
theme
design
theme
.. _about-docs:
About Read the Docs
-------------------
.. toctree::
:maxdepth: 2
:maxdepth: 2
:caption: About Read the Docs
open-source-philosophy
sponsors
talks
open-source-philosophy
sponsors
talks
.. Things that need more love before getting upgraded to the above list.
.. _ops-docs:
Operations Documentation
------------------------
.. toctree::
:maxdepth: 2
:maxdepth: 2
:caption: Operations Documentation
rtfd
rtfd