aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClément Pit-Claudel2018-05-16 21:25:56 -0400
committerThéo Zimmermann2018-09-20 10:12:55 +0200
commit838ba44a2e5dc7e2dd152ef10eb0c12096bd568c (patch)
treefe7878601a01f08ddf227bf362b64c2d79bf3620
parenta63bc54bfd697e76182044a8515818fa8f92e849 (diff)
[doc] Add env_version to metadata of coqrst plugin
This is required by Sphinx 8.0. See https://github.com/sphinx-doc/sphinx/issues/4460.
-rw-r--r--doc/tools/coqrst/coqdomain.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/tools/coqrst/coqdomain.py b/doc/tools/coqrst/coqdomain.py
index 5834ddaa4f..f62df94e36 100644
--- a/doc/tools/coqrst/coqdomain.py
+++ b/doc/tools/coqrst/coqdomain.py
@@ -1124,4 +1124,11 @@ def setup(app):
# Tell Sphinx about extra settings
app.add_config_value("report_undocumented_coq_objects", None, 'env')
- return {'version': '0.1', "parallel_read_safe": True}
+ # ``env_version`` is used by Sphinx to know when to invalidate
+ # coqdomain-specific bits in its caches. It should be incremented when the
+ # contents of ``env.domaindata['coq']`` change. See
+ # `https://github.com/sphinx-doc/sphinx/issues/4460`.
+ meta = { "version": "0.1",
+ "env_version": 1,
+ "parallel_read_safe": True }
+ return meta