Configuration
You can set the following options in your conf.py
file.
- multiproject_projects
A dictionary defining the projects that will share the configuration. You must define at least one project, by default the options from each project’s
conf.py
file would be used.Example:
multiproject_projects = { "dev": {}, "user": {}, }
Each project can have the following options:
- path
Path to the nested project’s
conf.py
file. By default, the key name used inmultiproject_projects
is also the directory name for the nested project’sconf.py
file. This can be a relative path (to the mainconf.py
file) or an absolute path.Example:
multiproject_projects = { "dev": { "path": "path/to/your/project/" }, }
- config
A dictionary of options specific to this project. This is useful if you don’t want to have a specific
conf.py
file for each project.Warning
There are some options that can’t be defined here, see Pre-init options.
Example:
multiproject_projects = { "dev": { "config": { "project": "My project", }, }, }
- use_config_file
If
True
, the configuration values from{path}/conf.py
would be automatically imported when building this project. Defaults toTrue
.The values from this file will have precedence over
config
.Warning
There are some options that can’t be defined on this file, see Pre-init options.
Example:
multiproject_projects = { "dev": { "use_config_file": True, }, }
- multiproject_env_var
The name of the environment variable to read the current project from. Defaults to
PROJECT
.Example:
multiproject_env_var = "SPHINX_PROJECT"