Merge pull request #35 from OSOceanAcoustics/rtd_migrate

Add config to migrate to readthedocs
OSOceanAcoustics · May 23, 2023 · 316c4ae · 316c4ae
2 parents ac04fa7 + 4c1df59
commit 316c4ae
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 47 deletions.
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
diff --git a/.gitignore b/.gitignore
@@ -139,3 +139,6 @@ dmypy.json
 # Jupyter Book
 _build/
 converted_ek60
+
+# Sphinx
+notebooks/conf.py
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,28 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+  jobs:
+    pre_build:
+      # Generate the Sphinx configuration for this Jupyter Book so it builds.
+      - "jupyter-book config sphinx notebooks"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: notebooks/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: []
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   install:
+      - requirements: notebooks/requirements.txt
diff --git a/notebooks/requirements.txt b/notebooks/requirements.txt
@@ -0,0 +1,2 @@
+# Dependecies for building the jupyter book
+jupyter-book