Skip to content

Commit 6717e37

Browse files
authored
Merge pull request #6991 from readthedocs/humitos/document-share-sphinx-doctree-flag
Document SHARE_SPHINX_DOCTREE flag
2 parents 285ae5e + afb1d4e commit 6717e37

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/guides/feature-flags.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,11 @@ e.g. python-reno release notes manager is known to do that
3636
``USE_TESTING_BUILD_IMAGE``: :featureflags:`USE_TESTING_BUILD_IMAGE`
3737

3838
``EXTERNAL_VERSION_BUILD``: :featureflags:`EXTERNAL_VERSION_BUILD`
39+
40+
``SHARE_SPHINX_DOCTREE``: :featureflags:`SHARE_SPHINX_DOCTREE`
41+
42+
By default, when Read the Docs runs Sphinx it passes a different output directory for the generated/parsed doctrees
43+
(the argument ``-d _build/doctrees-{builder}`` is passed to ``sphinx-build``).
44+
While this is a way to ensure that all the outputs are generated from scratch,
45+
it may cause your builds to be slow if you have a big set of documentation and builds multiple formats.
46+
In that case, enabling ``SHARE_SPHINX_DOCTREE`` could help to speed up your builds by sharing the doctree among all the formats.

0 commit comments

Comments
 (0)