Merge pull request #24 from DouglasNeuroInformatics/ci_checks

DouglasNeuroInformatics · Aug 4, 2021 · cb4135a · cb4135a
2 parents 304a61e + 991295c
commit cb4135a
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 4 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,13 @@
+name: "Pull Request Docs Check"
+on: 
+- pull_request
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+        build-command: "sphinx-build -n -W -b html . _build"
diff --git a/README.md b/README.md
@@ -7,9 +7,10 @@
 
 Follow these steps.
 
-1. `pip install -r requirements.txt`
-2. `cd docs` and then `make html`
-3. open `docs/_build/index.html`
+1. `cd docs`
+2. `pip install -r requirements.txt`
+3. `make html`
+4. open `docs/_build/index.html`
 
 To make changes, edit the markdown files.
 If you have done a major refactor (renaming files or directory structures), 
@@ -50,4 +51,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
diff --git a/docs/_static/.empty b/docs/_static/.empty
diff --git a/requirements.txt → docs/requirements.txt b/requirements.txt → docs/requirements.txt