Feature Flags

Read the Docs offers some additional flag settings which can be only be configured by the site admin. These are optional settings and you might not need it for every project. By default, these flags are disabled for every project. A separate request can be made by opening an issue on our github to enable or disable one or more of these featured flags for a particular project.

Available Flags

PIP_ALWAYS_UPGRADE: Always run pip install –upgrade

DONT_OVERWRITE_SPHINX_CONTEXT: Do not overwrite context vars in conf.py with Read the Docs context

DONT_SHALLOW_CLONE: Do not shallow clone when cloning git repos

The DONT_SHALLOW_CLONE flag is useful if your code accesses old commits during docs build, e.g. python-reno release notes manager is known to do that (error message line would probably include one of old Git commit id’s).

USE_TESTING_BUILD_IMAGE: Use Docker image labelled as `testing` to build the docs