atelier.sphinxconf¶
Sphinx extensions and a configure()
function used to build
the documentation trees maintained by us.
Basic extension |
|
Defines the |
|
A Sphinx extension which adds the |
|
Defines the |
|
Defines the |
|
Defines the |
|
This Sphinx extension defines the |
|
Defines the |
(This module’s source code is available here.)
Functions
|
Adds to your conf.py an arbitrary series of things that all my Sphinx docs configuration files have in common. |
|
used in docs/released/index.rst |
-
atelier.sphinxconf.
configure
(globals_dict)¶ Adds to your conf.py an arbitrary series of things that all my Sphinx docs configuration files have in common.
To be called from inside the Sphinx conf.py as follows:
from atelier.sphinxconf import configure configure(globals())
Incomplete list of conf.py settings that will be set:
extensions
templates_path
html_static_path
master_doc=’index’
source_suffix=’.rst’
primary_domain=’py’
pygments_style=’sphinx’
-
atelier.sphinxconf.
version2rst
(self, m)¶ used in docs/released/index.rst