[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
This commit is contained in:
parent
8644192564
commit
1c321b72cf
15
doc/conf.py
15
doc/conf.py
@ -34,7 +34,7 @@ sys.path.insert(0, os.path.abspath("../scripts"))
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
"sphinx.ext.autodoc",
|
||||
#'sphinx.ext.autosummary',
|
||||
"myst_parser",
|
||||
# "sphinx.ext.autosectionlabel",
|
||||
@ -50,7 +50,18 @@ extensions = [
|
||||
"sphinx.ext.imgconverter", # for SVG conversion
|
||||
]
|
||||
|
||||
autodoc_mock_imports = ["atlite", "snakemake", "pycountry", "rioxarray", "country_converter", "tabula", "memory_profiler", "powerplantmatching", "rasterio", "dask.distributed"]
|
||||
autodoc_mock_imports = [
|
||||
"atlite",
|
||||
"snakemake",
|
||||
"pycountry",
|
||||
"rioxarray",
|
||||
"country_converter",
|
||||
"tabula",
|
||||
"memory_profiler",
|
||||
"powerplantmatching",
|
||||
"rasterio",
|
||||
"dask.distributed",
|
||||
]
|
||||
|
||||
autodoc_default_flags = ["members"]
|
||||
autosummary_generate = True
|
||||
|
@ -47,4 +47,3 @@ We strive to keep documentation useful and up to date for all PyPSA users. If yo
|
||||
#. Compile your changes by running the following command in your terminal in the ``doc`` folder: ``make html``
|
||||
You may encounter some warnings, but end up with a message such as ``build succeeded, XX warnings.``. html files to review your changes can then be found under ``doc/_build/html``.
|
||||
#. Contribute your documentation in a pull request (`here is a guide <https://help.github.com/en/articles/about-pull-requests>`_).
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user