Set up RTD and auto build on PR (#182)

* initial setup of rtd build

* move workflow_minimal notebook to example_notebooks folder

* revert to render all notebooks

* remove doc requirements from requirements-dev

.readthedocs.yaml

@@ -0,0 +1,39 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+  jobs:
+    pre_build:
+      # Generate the Sphinx configuration for this Jupyter Book so it builds.
+      - "jupyter-book config sphinx docs"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/_config.yml

@@ -29,7 +29,7 @@ latex:
 # Information about where the book exists on the web
 repository:
   url: https://github.com/uw-echospace/EchoPro  # Online location of your book
-  # path_to_book: docs  # Optional path to your book, relative to the repository root
+  path_to_book: docs  # Optional path to your book, relative to the repository root
   branch: master  # Which branch of the repository should be used when creating links (optional)
 
 # Add GitHub buttons to your book
@@ -48,3 +48,5 @@ sphinx:
     'sphinx.ext.ifconfig',
     'sphinx.ext.githubpages'
   ]
+  config:
+    bibtex_reference_style: label

docs/_toc.yml

@@ -8,7 +8,7 @@ parts:
 - caption: Documentation
   chapters:
   - file: classes-datastructures
-  - file: workflow_minimal.ipynb
+  - file: example_notebooks/workflow_minimal.ipynb
   - file: input-files
 - caption: Notebooks
   chapters:

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx-automodapi
+jupyter-book
+numpydoc
+docutils<0.18

requirements-dev.txt

@@ -3,7 +3,3 @@ flake8
 isort
 pre-commit
 pytest
-sphinx-automodapi
-jupyter-book
-numpydoc
-docutils<0.18