Merge pull request labscript-suite#87 from dihm/docs_mock_imports

dihm · web-flow · commit de6fb9524686 · 2022-02-05T06:01:08.000-05:00
Mock `labscript_utils` to prevent RTD from trying to launch zprocess.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,14 +15,18 @@
 from m2r import MdInclude
 from recommonmark.transform import AutoStructify
 from jinja2 import FileSystemLoader, Environment
+try:
+    import importlib.metadata as importlib_metadata
+except ImportError:
+    import importlib_metadata
 
 # -- Project information (unique to each project) -------------------------------------
 
 project = "labscript"
 copyright = "2020, labscript suite"
 author = "labscript suite contributors"
 
-from labscript import __version__ as version  # noqa: E402
+version = importlib_metadata.version('labscript')
 
 release = version
 
@@ -51,6 +55,7 @@
 autodoc_typehints = 'description'
 autosummary_generate = True
 add_module_names = False
+autodoc_mock_imports = ['labscript_utils']
 
 # Prefix each autosectionlabel with the name of the document it is in and a colon
 autosectionlabel_prefix_document = True
