Merge pull request #35 from e10harvey/docs_check

.github/workflows: Add docs_check.yml

.github/workflows/docs_check.yml

@@ -0,0 +1,40 @@
+name: github-DOCS
+
+on:
+  push
+  #pull_request:
+  #  paths-ignore:
+  #  - '**/*.rst'
+  #  - '**/*.md'
+  #  - 'doc/**'
+  #  types: [ opened, reopened, synchronize ]
+
+permissions:
+  contents: none
+
+# Cancels any in progress 'workflow' associated with this PR
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  docs-check:
+    name: docs-check
+    runs-on: [ubuntu-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          path: OpenCSP
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Sphinx docs check
+        run: |
+          cd OpenCSP
+          pip install -r requirements.txt
+          cd doc
+          pip install -r requirements.txt
+          ./make_docs.sh
+          

doc/README.md

@@ -2,7 +2,9 @@
 
 ## Install requirements in virtual environment
 ```bash
-(venv) $ cd /path/to/OpenCSP/doc
+(venv) $ cd /path/to/OpenCSP
+(venv) $ pip install -r requirements.txt
+(venv) $ cd doc
 (venv) $ pip install -r requirements.txt
 ```