sphinx/doc/contents.rst

.. _contents:

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

.. toctree::
   :maxdepth: 2

   usage/index
   development/index
   man/index

   templating
   latex
   extdev/index

   internals/index

   faq
   glossary
   changes
   examples


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

.. only:: builder_html

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

.. only:: not builder_html

   * :ref:`modindex`
   * :ref:`glossary`
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
docs: Add usage, development index page Signed-off-by: Stephen Finucane <stephen@that.guru> 2020-05-29 17:06:16 +01:00			`usage/index`
			`development/index`
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`
docs: Add usage, development index page Signed-off-by: Stephen Finucane <stephen@that.guru> 2020-05-29 17:06:16 +01:00
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`
Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00			`extdev/index`
Add FAQ, to be expanded. 2009-02-12 12:50:42 +01:00
docs: Add "project internals" guide This is modelled off Django's guide of the same name [1]. In summary, this will contain most of the information previously found in the CONTRIBUTING document. For now, we move just the code of conduct and authors documents. Signed-off-by: Stephen Finucane <stephen@that.guru> 2020-05-30 14:45:35 +01:00			`internals/index`

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 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`
First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 21:32:24 +00: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 12:44:00 +00:00
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`