Prevent DB connection when building docs

mupif · Nov 7, 2023 · 2084b72 · 2084b72
1 parent 054e54e
commit 2084b72
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -105,7 +105,9 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-
+# for readthedocs.org, don't try to connect to the DB when importing mupifDB.api.main
+import os
+os.environ['MUPIFDB_DRY_RUN']='1'
 
 # Generate OpenAPI json description prior to running sphinx
 #

diff --git a/mupifDB/api/main.py b/mupifDB/api/main.py
@@ -73,7 +73,10 @@
 # import and initialize EDM
 if 1:
     import mupifDB.api.edm as edm
-    edm.initializeEdm(client)
+    # when imported at readthedocs, don't try to connect to the DB (no DB running there)
+    if not 'MUPIFDB_DRY_RUN' in os.environ:
+        edm.initializeEdm(client)
+    else: print('MUPIFDB_DRY_RUN defined, not initializing EDM DB connection.')
     app.include_router(edm.dms3.router)