prepping for GH actions - autodoc

.github/workflows/pull_request.yml

@@ -0,0 +1,27 @@
+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:
+        build-command: "make html"
+        docs-folder: "docs/"
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+        pre-build-command: "apt-get update -y && apt-get install -y latexmk texlive-latex-recommended texlive-xetex texlive-latex-extra texlive-fonts-recommended fonts-freefont-otf"
+        build-command: "make latexpdf"
+    # Create an artifact of the html output.
+    - uses: actions/upload-artifact@v1
+      with:
+        name: DocumentationHTML
+        path: docs/_build/html/
+    - uses: actions/upload-artifact@v1
+      with:
+        name: DocumentationPDFSpecification
+        path: docs/_build/latex/

.github/workflows/push.yml

@@ -0,0 +1,49 @@
+name: "Pull Request Docs Check"
+on: 
+- push
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        build-command: "make html"
+        docs-folder: "docs/"
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+        pre-build-command: "apt-get update -y && apt-get install -y latexmk texlive-latex-recommended texlive-xetex texlive-latex-extra texlive-fonts-recommended fonts-freefont-otf"
+        build-command: "make latexpdf"
+    # Create an artifact of the html output.
+    - uses: actions/upload-artifact@v1
+      with:
+        name: DocumentationHTML
+        path: docs/_build/html/
+    - uses: actions/upload-artifact@v1
+      with:
+        name: DocumentationPDFSpecification
+        path: docs/_build/latex/
+    # Publish built docs to gh-pages branch.
+    # ===============================
+    - name: Commit documentation changes
+      run: |
+        git clone https://github.com/kc1awv/M17_spec.git --branch gh-pages --single-branch gh-pages
+        cp -r docs/_build/html/* gh-pages/
+        cp -r docs/_build/latex/M17Protocol*.pdf gh-pages/
+        cd gh-pages
+        touch .nojekyll
+        git config --local user.email "smiller@kc1awv.net"
+        git config --local user.name "kc1awv"
+        git add .
+        git commit -m "Update PDF documentation" -a || true
+        # The above command will fail if no changes were present, so we ignore
+        # that.
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        branch: gh-pages
+        directory: gh-pages
+        github_token: ${{ secrets.GH_TOKEN }}
+    # ===============================

docs/application_layer.rst

@@ -89,17 +89,17 @@ algorithm.  Figures 5 to 8 show block diagrams of the algorithm
      - 24 bits
      - 16,777,215
 
-.. figure:: ../images/LFSR_8.svg
+.. figure:: ../images/LFSR_8.*
    :scale: 22%
 
    8-bit LFSR taps
 
-.. figure:: ../images/LFSR_16.svg
+.. figure:: ../images/LFSR_16.*
    :scale: 22%
 
    16-bit LFSR taps
 
-.. figure:: ../images/LFSR_24.svg
+.. figure:: ../images/LFSR_24.*
    :scale: 22%
 
    24-bit LFSR taps

docs/physical_layer.rst

@@ -97,7 +97,7 @@ the transmission.
 Link setup frame
 ~~~~~~~~~~~~~~~~
 
-.. figure:: ../images/link_setup_frame_encoding.svg
+.. figure:: ../images/link_setup_frame_encoding.*
 
    ECC stages for the link setup frame
 
@@ -117,7 +117,7 @@ transmitted. Interleaving is used to combat error bursts.
 Subsequent frames
 ~~~~~~~~~~~~~~~~~
 
-.. figure:: ../images/frame_encoding.svg
+.. figure:: ../images/frame_encoding.*
 
    ECC stages of subsequent frames
 
@@ -185,7 +185,7 @@ The output from the encoder must be read alternately.
 .. [NXDN] NXDN Technical Specifications, Part 1: Air Interface;
           Sub-part A: Common Air Interface
 
-.. figure:: ../images/convolutional.svg
+.. figure:: ../images/convolutional.*
    :scale: 30%
 
    Convolutional coder diagram