Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 708 Bytes

Project.rst

File metadata and controls

28 lines (20 loc) · 708 Bytes

Sphinx project

pair: sphinx; configuration conf.py pair: sphinx; Makefile

To start a Sphinx project use the interactive sphinx-quickstart command (Sphinx ref <man/sphinx-quickstart.html>). This will ask you all the necessary questions. You can use a Makefile to build the documentation.

Customization is done in the file conf.py (Sphinx ref <config.html>) and the Makefile <pair: sphinx; Makefile> (Sphinx ref <invocation.html#makefile-options>).

The configuration of the extensions go also in conf.py.

See Sphinx description of configuration options <config.html>.