From 355e4ace2fa75a4d6c50a3829e6ce8d276035aeb Mon Sep 17 00:00:00 2001
From: Evan Harvey <eharvey@sandia.gov>
Date: Tue, 19 Mar 2024 15:17:48 -0600
Subject: [PATCH] .github/workflows: Added docs_check.yml

---
 .github/workflows/docs_check.yml | 40 ++++++++++++++++++++++++++++++++
 doc/README.md                    |  4 +++-
 2 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/docs_check.yml

diff --git a/.github/workflows/docs_check.yml b/.github/workflows/docs_check.yml
new file mode 100644
index 000000000..b4978b6e6
--- /dev/null
+++ b/.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
+          
\ No newline at end of file
diff --git a/doc/README.md b/doc/README.md
index 07dc2c2b7..3afac1dcb 100644
--- a/doc/README.md
+++ b/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
 ```