Merge pull request #98 from open-plan-tool/auto-build-RTD

Setup auto-build RTD
open-plan-tool · Jan 17, 2023 · d784edf · d784edf
2 parents 4fdb40e + 8d1b762
commit d784edf
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,20 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Required
+version: 2
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+#formats:
+#  - pdf
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   version: 3.7
+   install:
+      - requirements: docs/requirements.txt
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+[![Documentation Status](https://readthedocs.org/projects/open-plan-documentation/badge/?version=latest)](https://open-plan-documentation.readthedocs.io/en/latest/?badge=latest)
+
 Welcome to the open_plan documentation repository,
 
 Here the code of the documentation will be available. If you want to get notified when the code gets uploaded you can send an email to open_plan@rl-institut.de.

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,4 @@
+sphinx>=2.3.1
+sphinx_rtd_theme>=0.4.3
+numpydoc>=1.1.0
+pandas>==1.1.3