Merge pull request #658 from pz-max/doc-patch

fix docs build in readthedocs

.readthedocs.yml

@@ -4,8 +4,14 @@
 
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  apt_packages:
+  - graphviz
+
 python:
-  version: 3.8
   install:
   - requirements: doc/requirements.txt
-  system_packages: true
+  system_packages: false

doc/conf.py

@@ -36,6 +36,7 @@ sys.path.insert(0, os.path.abspath("../scripts"))
 extensions = [
     #'sphinx.ext.autodoc',
     #'sphinx.ext.autosummary',
+    "myst_parser",
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",

doc/release_notes.rst

@@ -17,7 +17,7 @@ Upcoming Release
 
 * Renamed script file from PyPSA-EUR ``build_load_data`` to ``build_electricity_demand`` and ``retrieve_load_data`` to ``retrieve_electricity_demand``.
 
-
+* Fix docs readthedocs built
 
 * Add plain hydrogen turbine as additional re-electrification option besides
   hydrogen fuel cell. Add switches for both re-electrification options under

doc/requirements.txt

@@ -2,9 +2,11 @@
 #
 # SPDX-License-Identifier: CC0-1.0
 
+setuptools
 sphinx
 sphinx_book_theme
 sphinxcontrib-bibtex
+myst-parser  # recommark is deprecated, https://stackoverflow.com/a/71660856/13573820
 
 pypsa
 vresutils>=0.3.1