sphinx/doc/contents.rst


.. _contents:

Sphinx documentation contents
=============================

.. toctree::
   :maxdepth: 2

   usage/installation
   usage/quickstart
   usage/restructuredtext/index
   usage/markdown
   usage/configuration
   usage/builders/index

   intro
   man/index
   intl
   theming
   setuptools
   templating
   latex
   extensions
   extdev/index
   websupport

   faq
   glossary
   devguide
   changes
   examples
   authors


Indices and tables
==================

.. only:: builder_html

   * :ref:`genindex`
   * :ref:`modindex`
   * :ref:`search`
   * :ref:`glossary`

.. only:: not builder_html

   * :ref:`modindex`
   * :ref:`glossary`
New latex.rst for extended documentation of LaTeX's customizing. 2016-06-18 13:25:48 -05:00
First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 16:32:24 -05:00			`.. _contents:`

			`Sphinx documentation contents`
			`=============================`

			`.. toctree::`
Allow new titles in the toctree. 2008-03-30 01:36:20 -05:00			`:maxdepth: 2`
First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 16:32:24 -05:00
doc: Create usage guide section Start structuring our docs a little better starting with a usage guide. There are a number of changes happening here. We're going to start with the installation guide, which is simply moved to the appropriate subdirectory. Signed-off-by: Stephen Finucane <stephen@that.guru> 2018-02-06 14:22:13 -06:00			`usage/installation`
doc: Add "quickstart" doc to usage guide This is simply the former 'tutorial' document renamed. A number of references need to be updated, so this is done. Signed-off-by: Stephen Finucane <stephen@that.guru> 2017-11-03 07:44:00 -05:00			`usage/quickstart`
doc: Add "restructuredtext" section to usage guide This is taken from the existing 'rest' documents. Little to no modifications are necessary, thankfully. Signed-off-by: Stephen Finucane <stephen@that.guru> 2017-11-03 07:44:39 -05:00			`usage/restructuredtext/index`
doc: Add "markdown" section to usage guide Signed-off-by: Stephen Finucane <stephen@that.guru> 2017-11-03 15:13:16 -05:00			`usage/markdown`
doc: Add "config" to usage guide Signed-off-by: Stephen Finucane <stephen@that.guru> 2018-02-26 05:49:23 -06:00			`usage/configuration`
doc: Add "builders" to usage guide This is placed in a directory as this document will eventually be split up. However, this is not the day to do this. Signed-off-by: Stephen Finucane <stephen@that.guru> 2017-11-03 15:52:13 -05:00			`usage/builders/index`
doc: Create usage guide section Start structuring our docs a little better starting with a usage guide. There are a number of changes happening here. We're going to start with the installation guide, which is simply moved to the appropriate subdirectory. Signed-off-by: Stephen Finucane <stephen@that.guru> 2018-02-06 14:22:13 -06:00
Update documentation, add more content. 2008-03-16 06:19:26 -05:00			`intro`
doc: Remove 'invocation' document This contains no useful information at this point. Better to simply drop it. Signed-off-by: Stephen Finucane <stephen@that.guru> 2017-07-04 14:32:36 -05:00			`man/index`
Document gettext builder and create i18n docs. 2010-06-26 05:38:06 -05:00			`intl`
Theming docs, part 1. 2009-02-15 03:45:46 -06:00			`theming`
doc: Add guide on setuptool/distutils integration While this feature is somewhat documented in the API guide, there's nothing about this option in the main user guide. Given the lack of blogs and articles talking about this feature, along with the amount of projects that are only using the same copy-paste '[build_sphinx]' definition, I imagine this is an issue. Make the feature a little more accessible by adding a section to the main user guide that details (a) the fact the feature exists, (b) why you'd want to use it, and (c) how you can use it. Signed-off-by: Stephen Finucane <stephen@that.guru> 2017-02-24 12:10:47 -06:00			`setuptools`
Update documentation, add more content. 2008-03-16 06:19:26 -05:00			`templating`
New latex.rst for extended documentation of LaTeX's customizing. 2016-06-18 13:25:48 -05:00			`latex`
Update documentation, add more content. 2008-03-16 06:19:26 -05:00			`extensions`
Doc: move API docs in their own chapter and add more of it. 2014-01-20 10:21:44 -06:00			`extdev/index`
rough documentation 2010-06-04 16:13:53 -05:00			`websupport`
Add FAQ, to be expanded. 2009-02-12 05:50:42 -06:00
			`faq`
Update documentation, add more content. 2008-03-16 06:19:26 -05:00			`glossary`
Add initial draft of "Sphinx Developer's Guide" 2012-11-29 19:11:19 -06:00			`devguide`
Add the changelog to the documentation. 2008-03-23 16:25:19 -05:00			`changes`
Add "who uses it" page. 2008-06-23 07:35:22 -05:00			`examples`
Add documentation to make contribution easier. 2014-08-30 10:02:01 -05:00			`authors`
First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 16:32:24 -05:00

doc: Add "quickstart" doc to usage guide This is simply the former 'tutorial' document renamed. A number of references need to be updated, so this is done. Signed-off-by: Stephen Finucane <stephen@that.guru> 2017-11-03 07:44:00 -05:00
First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 16:32:24 -05:00			`Indices and tables`
			`==================`

Fix document for epub 2016-09-01 11:07:14 -05:00			`.. only:: builder_html`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`
			* :ref:`glossary`

			`.. only:: not builder_html`

			* :ref:`modindex`
			* :ref:`glossary`