Merge pull request #235 from simonsobs/koopman/rtd-config

Create rtd config file, split requirements, pin versions, and
remove docs test builds from workflows.

.github/workflows/develop.yml

@@ -36,10 +36,6 @@ jobs:
         coverage report
         coveralls --service=github
 
-    - name: Test documentation build
-      run: |
-        docker run --rm ocs sh -c "make -C docs/ html"
-
     # Dockerize
     - name: Build and push development docker image
       env:

.github/workflows/official-docker-images.yml

@@ -28,10 +28,6 @@ jobs:
       run: |
         docker run -v $PWD:/coverage --rm ocs sh -c "COVERAGE_FILE=/coverage/.coverage.docker python3 -m pytest -m 'not integtest' --cov /app/ocs/ocs/ ./tests/"
 
-    - name: Test documentation build
-      run: |
-        docker run --rm ocs sh -c "make -C docs/ html"
-
     # Dockerize
     - name: Build and push official docker image
       env:

.github/workflows/pytest.yml

@@ -43,7 +43,3 @@ jobs:
         coverage combine
         coverage report
         coveralls --service=github
-
-    - name: Test documentation build
-      run: |
-        docker run --rm ocs sh -c "make -C docs/ html"

.readthedocs.yaml

@@ -0,0 +1,10 @@
+version: 2
+
+sphinx:
+    configuration: docs/conf.py
+
+python:
+    version: 3.7
+    install:
+    - requirements: docs/requirements.txt
+    - requirements: requirements.txt

README.rst

@@ -88,10 +88,12 @@ be considered unstable.
 
 Documentation
 -------------
-The OCS documentation can be built using sphinx once you have performed the
-installation::
+The OCS documentation can be built using Sphinx. There is a separate
+``requirements.txt`` file in the ``docs/`` directory to install Sphinx and any
+additional documentation dependencies::
 
   $ cd docs/
+  $ pip3 install -r requirements.txt
   $ make html
 
 You can then open ``docs/_build/html/index.html`` in your preferred web

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx==4.2.0
+sphinx_rtd_theme==1.0.0
+sphinx-argparse==0.3.1

requirements.txt

@@ -12,9 +12,7 @@ numpy
 pyserial
 
 # Documentation generation
-sphinx
-sphinx-argparse
-sphinx_rtd_theme
+# see docs/requirements.txt
 
 # checkdata
 progress