atelier.sphinxconf¶
(This module’s source code is available here.)
Sphinx setup used to build most of the documentation trees mainained by myself.
| insert_input | (This module’s source code is available here.) |
| refstothis | (This module’s source code is available here.) |
| sigal_image | (This module’s source code is available here.) |
| complex_tables | (This module’s source code is available here.) |
| blog | (This module’s source code is available here.) |
| base | (This module’s source code is available here.) |
| dirtables | (This module’s source code is available here.) |
Functions
| configure(globals_dict[, settings_module_name]) | Adds to your conf.py an arbitrary series of things that all my Sphinx docs configuration files have in common. |
| load_projects() | |
| version2rst(self, m) | used in docs/released/index.rst |
Classes
| BuiltinTemplateLoader | Interfaces the rendering environment of jinja2 for use in Sphinx. |
| DjangoTemplateBridge | The configure() method installs this as template_bridge for Sphinx. |
| Path |
- class atelier.sphinxconf.DjangoTemplateBridge¶
The configure() method installs this as template_bridge for Sphinx. It causes a template variable settings to be added the Sphinx template context. This cannot be done using html_context because Django settings are not pickleable.
- atelier.sphinxconf.configure(globals_dict, settings_module_name=None)¶
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 djangosite.utils.sphinxconf import configure configure(globals())
Incomplete list of conf.py settings that will be set:
- intersphinx_mapping : The intersphinx entries for projects
managed in this atelier. Atelier gets this information by checking for an attribute intersphinx_urls in the global namespace of each project’s main module.
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