Documentation/doc-guide/sphinx.rst

6 The Linux kernel uses `Sphinx`_ to generate pretty documentation from
26 Sphinx Install
30 built with ``Sphinx`` version 1.3 or higher.
32 There's a script that checks for the Sphinx requirements. Please see
35 Most distributions are shipped with Sphinx, but its toolchain is fragile,
41 Sphinx inside a virtual environment, using ``virtualenv-3``
46    #) Sphinx versions below 1.5 don't work properly with Python's
51       on the Sphinx version, it should be installed  in separate,
54    #) Some ReST pages contain math expressions. Due to the way Sphinx work,
58 In summary, if you want to install Sphinx version 1.7.9, you should do::
84 Such builds are currently supported only with Sphinx versions 1.4 and higher.
94 Checking for Sphinx dependencies
97 There's a script that automatically check for Sphinx dependencies. If it can
124 	Use OS packaging for Sphinx instead of Python virtual environment.
127 Sphinx Build
135 To generate documentation, Sphinx (``sphinx-build``) must obviously be
136 installed. For prettier HTML output, the Read the Docs Sphinx theme
141 To pass extra options to Sphinx, you can use the ``SPHINXOPTS`` make
153 2. Refer to it from the Sphinx main `TOC tree`_ in ``Documentation/index.rst``.
164 See the documentation for `Sphinx`_ and `reStructuredText`_ on what you can do
165 with them. In particular, the Sphinx `reStructuredText Primer`_ is a good place
166 to get started with reStructuredText. There are also some `Sphinx specific
226 The **Sphinx C Domain** (name c) is suited for documentation of C API. E.g. a
247 references to function documentation.  Due to some Sphinx extension magic,
349 If you want to use a relative path, you need to use Sphinx's ``doc`` directive.