add to build to readthedocs (#215)

* add to build to readthedocs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * use python 3.9 in readthedocs.yaml * remove python.version * use python 3.11 * 3.10 * add pyyaml==5.3.1 to docs * add mkdocs.yml * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update path --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jacob Bieker <[email protected]>
openclimatefix · Jan 29, 2024 · 8a0be80 · 8a0be80
1 parent d82dd24
commit 8a0be80
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,8 +1,13 @@
 version: 2
 mkdocs: {} # tell readthedocs to use mkdocs
 python:
-  version: 3.7
   install:
     - method: pip
       path: .
     - requirements: docs/requirements.txt
+
+# the build.os and build.tools section is mandatory
+build:
+  os: ubuntu-20.04  # for consistency, matches the one used for CI
+  tools:
+    python: "3.10"
diff --git a/docs/.readthedocs-custom-steps.yml b/docs/.readthedocs-custom-steps.yml
@@ -1,3 +1,3 @@
 steps:
   - |
-    pydoc-markdown --build --site-dir "$PWD/_build/html"
+    pydoc-markdown --build --site-dir "$READTHEDOCS_OUTPUT/html"
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
 readthedocs-custom-steps==0.5.1
 jinja2<3.1.0
 pydoc-markdown
+pyyaml==5.3.1
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,5 @@
+site_name: Satip
+site_url: https://github.com/openclimatefix/Satip
+nav:
+  - Home: README.md
+theme: readthedocs