set environmt METATENSOR_IMPORT_FOR_SPHINX

This properly references TensorMap types in the doc instead of only showing abstruse ScriptClass types
lab-cosmo · Sep 22, 2023 · c1dc541 · c1dc541
1 parent d1cf32d
commit c1dc541
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -16,6 +16,10 @@
 
 ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))
 
+# when importing metatensor-torch, this will change the definition of the classes
+# to include the documentation
+os.environ["METATENSOR_IMPORT_FOR_SPHINX"] = "1"
+
 sys.path.insert(0, os.path.abspath('../../'))
 
 # -- Project information -----------------------------------------------------