sphinx/doc/contents.rst


.. _contents:

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

.. toctree::
   :maxdepth: 2

   intro
   tutorial
   man/index
   rest
   markup/index
   domains
   builders
   config
   intl
   theming
   setuptools
   templating
   latex
   markdown
   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 20:25:48 +02:00
First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 21:32:24 +00:00			`.. _contents:`

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

			`.. toctree::`
Allow new titles in the toctree. 2008-03-30 06:36:20 +00:00			`:maxdepth: 2`
First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 21:32:24 +00:00
Update documentation, add more content. 2008-03-16 11:19:26 +00:00			`intro`
Begin the Great Refactoring of the docs. * Move sphinx-build option description from intro to a new document. * Move toctree information to a new document in markup/. * Add a tutorial document placed after intro. Begin filling it in. 2010-02-28 22:00:22 +01:00			`tutorial`
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 20:32:36 +01:00			`man/index`
Update documentation, add more content. 2008-03-16 11:19:26 +00:00			`rest`
			`markup/index`
A bit of domain documentation. 2010-01-17 19:16:18 +01:00			`domains`
Update documentation, add more content. 2008-03-16 11:19:26 +00:00			`builders`
			`config`
Document gettext builder and create i18n docs. 2010-06-26 12:38:06 +02:00			`intl`
Theming docs, part 1. 2009-02-15 10:45:46 +01: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 13:10:47 -05:00			`setuptools`
Update documentation, add more content. 2008-03-16 11:19:26 +00:00			`templating`
New latex.rst for extended documentation of LaTeX's customizing. 2016-06-18 20:25:48 +02:00			`latex`
document markdown support #2303 #825 2017-01-29 10:58:22 +01:00			`markdown`
Update documentation, add more content. 2008-03-16 11:19:26 +00:00			`extensions`
Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00			`extdev/index`
rough documentation 2010-06-04 16:13:53 -05:00			`websupport`
Add FAQ, to be expanded. 2009-02-12 12:50:42 +01:00
			`faq`
Update documentation, add more content. 2008-03-16 11:19:26 +00: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 21:25:19 +00:00			`changes`
Add "who uses it" page. 2008-06-23 12:35:22 +00:00			`examples`
Add documentation to make contribution easier. 2014-08-31 00:02:01 +09:00			`authors`
First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 21:32:24 +00:00

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

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

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

			`.. only:: not builder_html`

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