Merge pull request #365 from openego/dev

Release 0.2.1
openego · Apr 2, 2023 · abf607b · abf607b
2 parents 9350c60 + 1f6b36e
commit abf607b
Show file tree

Hide file tree

Showing 56 changed files with 657 additions and 554 deletions.
diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml
@@ -0,0 +1,17 @@
+name: "Docs link check"
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install dependencies
+      run: |
+        sudo apt install pandoc
+        python -m pip install --upgrade pip
+        pip install -r rtd_requirements.txt
+    - name: Check doc links
+      run: |
+        sphinx-build . -b linkcheck -d _build/doctrees _build/html
+      working-directory: ./doc
diff --git a/doc/Makefile b/doc/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/api.rst b/doc/api.rst
diff --git a/doc/api/edisgo.flex_opt.rst b/doc/api/edisgo.flex_opt.rst
diff --git a/doc/api/edisgo.io.rst b/doc/api/edisgo.io.rst
diff --git a/doc/api/edisgo.network.rst b/doc/api/edisgo.network.rst
diff --git a/doc/api/edisgo.opf.rst b/doc/api/edisgo.opf.rst
diff --git a/doc/api/edisgo.tools.rst b/doc/api/edisgo.tools.rst
diff --git a/doc/api/edisgo_class.rst b/doc/api/edisgo_class.rst