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 Writing Sphinx Extensions.

* reStructuredText

  * reStructuredText Primer

  * Roles

  * Directives

  * Field Lists

  * Domains

* Markdown

  * Configuration

* Configuration

  * Project information

  * General configuration

  * Options for internationalization

  * Options for Math

  * Options for HTML output

  * Options for Single HTML output

  * Options for HTML help output

  * Options for Apple Help output

  * Options for epub output

  * Options for LaTeX output

  * Options for text output

  * Options for manual page output

  * Options for Texinfo output

  * Options for QtHelp output

  * Options for the linkcheck builder

  * Options for the XML builder

  * Options for the C domain

  * Options for the C++ domain

  * Options for the Python domain

  * Options for the Javascript domain

  * Example of configuration file

* Builders

  * "StandaloneHTMLBuilder"

  * "DirectoryHTMLBuilder"

  * "SingleFileHTMLBuilder"

  * "HTMLHelpBuilder"

  * "QtHelpBuilder"

  * "AppleHelpBuilder"

  * "DevhelpBuilder"

  * "Epub3Builder"

  * "LaTeXBuilder"

  * "TextBuilder"

  * "ManualPageBuilder"

  * "TexinfoBuilder"

  * "SerializingHTMLBuilder"

  * "PickleHTMLBuilder"

  * "JSONHTMLBuilder"

  * "MessageCatalogBuilder"

  * "ChangesBuilder"

  * "DummyBuilder"

  * "CheckExternalLinksBuilder"

  * "XMLBuilder"

  * "PseudoXMLBuilder"

  * Serialization builder details

* Extensions

  * Built-in extensions

  * Third-party extensions

* HTML Theming

  * Builders

  * Themes

* Internationalization

  * Sphinx internationalization details

  * Translating with sphinx-intl

  * Using Transifex service for team translation

  * Using Weblate service for team translation

  * Contributing to Sphinx reference translation

  * Translation progress and statistics

* Sphinx Web Support

  * Web Support Quick Start

  * The WebSupport Class

  * Search Adapters

  * Storage Backends
