Migrate to GitHub Actions

.github/workflows/deploy.yml

@@ -0,0 +1,60 @@
+#
+# Build and deploy the documentation
+#
+name: Deploy
+
+on:
+  #pull_request: # enable pull_request for testing
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -l {0}
+    steps:
+      # Cancel previous runs that are not completed
+      - name: Cancel Previous Runs
+        uses: styfle/[email protected]
+
+      - name: Checkout
+        uses: actions/[email protected]
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Build HTML documentaiton
+        run: make build_html
+
+      - name: Install TinyTeX
+        uses: r-lib/actions/setup-tinytex@v1
+
+      - name: Install LaTeX packages
+        run: |
+          tlmgr update --self
+          tlmgr install capt-of ctex datetime2 enumitem everysel fancyhdr \
+                        fandol float ms needspace oberdiek parskip sourcecodepro tabulary \
+                        titlesec tracklang ulem upquote varwidth wrapfig \
+                        xcolor xecjk zhnumber
+          # Update the fonts
+          sudo cp -r ~/.TinyTeX/texmf-dist/fonts/opentype/adobe/ /usr/share/fonts/opentype
+          fc-cache -f -v
+
+      - name: Build PDF documentaiton
+        run: make build_pdf
+
+      - name: Deploy documentation
+        uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build/dirhtml
+          # Only keep the latest commit to avoid bloating the repository
+          force_orphan: true
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'

Makefile

@@ -2,29 +2,44 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -j auto
 SPHINXBUILD   = sphinx-build
+SPHINXOPTS    = -j auto
 SOURCEDIR     = source
 BUILDDIR      = build
+DOCNAME       = SAC_Docs
+HTML          = dirhtml
+LATEXPDF      = latexpdf
 
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help Makefile build build_html build_pdf server watch
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-build: dirhtml latexpdf
-	cp $(BUILDDIR)/latex/SAC_Docs.pdf $(BUILDDIR)/dirhtml
+build: build_html build_pdf
+
+build_html: $(HTML)
 
-serve: dirhtml
-	cd $(BUILDDIR)/dirhtml && python -m http.server
+build_pdf: $(LATEXPDF)
+	@echo
+	@echo "Copy built PDF to HTML directory"
+	@echo
+	cp $(BUILDDIR)/latex/$(DOCNAME).pdf $(BUILDDIR)/$(HTML)/
+
+server: $(HTML)
+	@echo
+	@echo "Running a server on port 8009"
+	@echo "Open http://localhost:8009 in a web browser to preview the documentation"
+	@echo
+	cd $(BUILDDIR)/$(HTML) && python -m http.server 8009
 
 # Watch a Sphinx directory and rebuild the documentation when a change is detected.
 # See https://github.com/GaretJax/sphinx-autobuild for details
 watch:
-	sphinx-autobuild --open-browser --delay 1 -b dirhtml $(SOURCEDIR) $(BUILDDIR)/dirhtml
+	sphinx-autobuild --open-browser --delay 1 -b ${HTML} ${SPHINXOPTS} $(SOURCEDIR) $(BUILDDIR)/${HTML}
+