From 37ea7191529830118d5c05f8124fe3c5b41ece32 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 29 Apr 2020 14:22:45 +0200 Subject: [PATCH 1/2] Document SHARE_SPHINX_DOCTREE flag --- docs/guides/feature-flags.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/guides/feature-flags.rst b/docs/guides/feature-flags.rst index 7341ca4e268..aaad3cbd30e 100644 --- a/docs/guides/feature-flags.rst +++ b/docs/guides/feature-flags.rst @@ -35,4 +35,12 @@ e.g. python-reno release notes manager is known to do that ``USE_TESTING_BUILD_IMAGE``: :featureflags:`USE_TESTING_BUILD_IMAGE` -``EXTERNAL_VERSION_BUILD``: :featureflags:`EXTERNAL_VERSION_BUILD` \ No newline at end of file +``EXTERNAL_VERSION_BUILD``: :featureflags:`EXTERNAL_VERSION_BUILD` + +``SHARE_SPHINX_DOCTREE``: :featureflag:`SHARE_SPHINX_DOCTREE` + +By default, when Read the Docs runs Sphinx it passes a different output directory for the generated/parsed doctrees +(the argument ``-d _build/doctrees-{builder}`` is passed to ``sphinx-build``). +While this is a way to ensure that all the outputs are generated from scratch, +it may cause your builds to be slow if you have a big set of documentation and builds multiple formats. +In that case, enabling ``SHARE_SPHINX_DOCTREE`` could help to speed up your builds by sharing the doctree among all the formats. From afb1d4e897cf6353f274c8af908812909da45169 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 29 Apr 2020 16:44:35 +0200 Subject: [PATCH 2/2] Fix role name --- docs/guides/feature-flags.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/feature-flags.rst b/docs/guides/feature-flags.rst index 12b78780940..9beb7043aa9 100644 --- a/docs/guides/feature-flags.rst +++ b/docs/guides/feature-flags.rst @@ -37,7 +37,7 @@ e.g. python-reno release notes manager is known to do that ``EXTERNAL_VERSION_BUILD``: :featureflags:`EXTERNAL_VERSION_BUILD` -``SHARE_SPHINX_DOCTREE``: :featureflag:`SHARE_SPHINX_DOCTREE` +``SHARE_SPHINX_DOCTREE``: :featureflags:`SHARE_SPHINX_DOCTREE` By default, when Read the Docs runs Sphinx it passes a different output directory for the generated/parsed doctrees (the argument ``-d _build/doctrees-{builder}`` is passed to ``sphinx-build``).