Activate Sphinx automodules, add mock imports for missing pypsa-eur modules in environment used to build documentation

This commit is contained in:
chrstphtrs 2024-04-11 15:37:54 +02:00
parent 73971199d2
commit 8644192564

View File

@ -34,10 +34,10 @@ sys.path.insert(0, os.path.abspath("../scripts"))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
#'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
#'sphinx.ext.autosummary', #'sphinx.ext.autosummary',
"myst_parser", "myst_parser",
"sphinx.ext.autosectionlabel", # "sphinx.ext.autosectionlabel",
"sphinx.ext.intersphinx", "sphinx.ext.intersphinx",
"sphinx.ext.todo", "sphinx.ext.todo",
"sphinx.ext.mathjax", "sphinx.ext.mathjax",
@ -50,6 +50,8 @@ extensions = [
"sphinx.ext.imgconverter", # for SVG conversion "sphinx.ext.imgconverter", # for SVG conversion
] ]
autodoc_mock_imports = ["atlite", "snakemake", "pycountry", "rioxarray", "country_converter", "tabula", "memory_profiler", "powerplantmatching", "rasterio", "dask.distributed"]
autodoc_default_flags = ["members"] autodoc_default_flags = ["members"]
autosummary_generate = True autosummary_generate = True