bjoern/pypsa-eur
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[pre-commit.ci] auto fixes from pre-commit.com hooks

Browse Source 
for more information, see https://pre-commit.ci
This commit is contained in:
pre-commit-ci[bot] 2024-04-11 14:53:09 +00:00
parent 8644192564
commit 1c321b72cf
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/conf.py
View File

@ -34,7 +34,7 @@ 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",
@ -50,7 +50,18 @@ 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_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

1
doc/contributing.rst
View File

@ -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`` #. 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``. 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>`_). #. Contribute your documentation in a pull request (`here is a guide <https://help.github.com/en/articles/about-pull-requests>`_).