Automatic docs build

.github/workflows/docs-build.yaml

@@ -0,0 +1,48 @@
+name: docs-build
+on :
+  pull_request:
+    paths:
+      - "mcat/*.py"
+
+jobs:
+  docs-build:
+    name: Docs build
+    runs-on: ubuntu-latest
+    env:
+      # see tox.ini
+      TOXENV: docs
+
+    steps:
+      - name: Checkout repository code
+        uses: actions/checkout@v2
+
+      - name: Setup python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+
+      - name: Install python packages
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade tox
+
+      - name: Run tox (${{ env.TOXENV }})
+        run: tox
+
+      - name: Get git status
+        id: git_status
+        run: |
+          if [ $(git status --porcelain) == "" ]; then
+            echo ::set-output name=uncommitted::false
+          else
+            echo ::set-output name=uncommitted::true
+          fi
+
+      - name: Check for uncommited docs
+        if: ${{steps.git_status.outputs.uncommitted}}
+        run: |
+          echo "Uncommitted docs found. Faliing the job."
+          exit 1
+
+
+

.github/workflows/github-actions-test.yml

@@ -1,5 +1,11 @@
 name: test
-on : [pull_request, push]
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
 jobs:
   mcat-action-test:
     strategy:

README.md

@@ -184,7 +184,7 @@ Auto-generated API documentation can be found in
 Run the following command to update the API documentation
 
 ```python
-PYTHONPATH=./mcat pdoc --html --output-dir docs mcat
+tox -e docs
 ```
 
 ## Blog Posts

docs/index.html

@@ -0,0 +1 @@
+<meta http-equiv="refresh" content="0; url=./mcat/index.html" />

mcat/commentAnalysis.py

@@ -14,6 +14,7 @@ def __init__(self, words):
         """
         Constructors form a dictionary to be used for counting.
         Parameters: words - list of words to count
+        Test docs
         """
         self.word_count = {word.lower(): 0 for word in words}  # Create dictionary with list items as key
         self.vader_sentiment = vader.SentimentIntensityAnalyzer()  # Initialize sentiment analysis model

tox.ini

@@ -4,14 +4,20 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = py
+envlist = py, docs
 skipsdist=True
 
 [testenv]
-changedir = 
-    {toxinidir}
+changedir = {toxinidir}
 deps =  
     -r{toxinidir}/requirements.txt
 
 commands =
     python -m unittest discover -s tests
+
+[testenv:docs]
+changedir = {toxinidir}
+allowlist_externals = /bin/sh
+                      /usr/bin/sh
+commands =
+    sh -c 'PYTHONPATH=./mcat pdoc --force --html --output-dir docs mcat'