build_jinja_contexts

phalanx.docs.jinja.build_jinja_contexts()

Construct the Jinja contexts used for building Phalanx documentation.

Must be run from the root of the Phalanx documentation tree (a subdirectory of the configuration tree). This is normally arranged by Sphinx.

Returns:

Dict of contexts. There will be top-level keys for each environment and for each application. The former will have an env key containing the environment details. The latter will have an app key contianing the application and an envs key containing all the environment details.

Return type:

dict of dict