🔧 Set env_version for sphinx extension (#1313)

See https://www.sphinx-doc.org/en/master/extdev/index.html#extension-metadata
useblocks · Oct 2, 2024 · ede3b06 · ede3b06
1 parent aa34901
commit ede3b06
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/sphinx_needs/data.py b/sphinx_needs/data.py
@@ -32,6 +32,12 @@
 
 LOGGER = getLogger(__name__)
 
+ENV_DATA_VERSION: Final = 2
+"""Version of the data stored in the environment.
+
+See https://www.sphinx-doc.org/en/master/extdev/index.html#extension-metadata
+"""
+
 
 class NeedsPartType(TypedDict):
     """Data for a single need part."""

diff --git a/sphinx_needs/needs.py b/sphinx_needs/needs.py
@@ -22,7 +22,12 @@
     build_needumls_pumls,
 )
 from sphinx_needs.config import NEEDS_CONFIG, LinkOptionsType, NeedsSphinxConfig
-from sphinx_needs.data import NeedsCoreFields, SphinxNeedsData, merge_data
+from sphinx_needs.data import (
+    ENV_DATA_VERSION,
+    NeedsCoreFields,
+    SphinxNeedsData,
+    merge_data,
+)
 from sphinx_needs.defaults import (
     GRAPHVIZ_STYLE_DEFAULTS,
     LAYOUTS,
@@ -303,6 +308,7 @@ def setup(app: Sphinx) -> dict[str, Any]:
         "version": VERSION,
         "parallel_read_safe": True,
         "parallel_write_safe": True,
+        "env_version": ENV_DATA_VERSION,
     }