Add GitHub action for doc build tests

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>

Author: AyanSinhaMahapatra

.github/workflows/docs-ci.yml

@@ -0,0 +1,37 @@
+name: CI Documentation
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.7]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Give permission to run scripts
+        run: chmod +x ./docs/scripts/doc8_style_check.sh
+
+      - name: Install Dependencies
+        run:  pip install -e .[docs]
+
+      - name: Check Sphinx Documentation build minimally
+        working-directory: ./docs
+        run: sphinx-build -E -W source build
+
+      - name: Check for documentation style errors
+        working-directory: ./docs
+        run: ./scripts/doc8_style_check.sh
+
+

docs/source/skeleton/index.rst

@@ -2,14 +2,14 @@
 # Rst docs - https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
 #
 # 	1. Place docs in folders under source for different sections
-#   2. Link them by adding individual index files in each section 
+#   2. Link them by adding individual index files in each section
 #      to the main index, and then files for each section to their
 #      respective index files.
 #   3. Use `.. include` statements to include other .rst files
 #      or part of them, or use hyperlinks to a section of the docs,
 #      to get rid of repetition.
 #      https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment
-#   
+#
 #   Note: Replace these guide/placeholder docs
 
 .. include:: ../../../README.rst