doc: use BuildTheDocs, add CI workflow

Author: umarcor

.btd.yml

@@ -0,0 +1,5 @@
+input: doc
+output: _build
+target: gh-pages
+formats: [ html ]
+theme: https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v1

.github/workflows/Test.yml

@@ -0,0 +1,28 @@
+name: Doc
+
+on:
+  push:
+  schedule:
+    - cron: '0 0 * * 5'
+  workflow_dispatch:
+
+jobs:
+
+  BTD:
+    name: '📓 Docs'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: '🧰 Checkout'
+        uses: actions/checkout@v2
+
+      - name: '📓 BuildTheDocs (BTD)'
+        uses: buildthedocs/btd@v0
+        with:
+          token: ${{ github.token }}
+
+      - name: '📤 Upload artifact: HTML'
+        uses: actions/upload-artifact@master
+        with:
+          name: doc
+          path: doc/_build/html

.gitignore

@@ -1 +1,3 @@
 *.pyc
+/doc/_build
+/doc/_theme

doc/.nojekyll

@@ -1,20 +1,37 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
+# Sphinx options.
 SPHINXOPTS    =
-SPHINXBUILD   = python -msphinx
-SPHINXPROJ    = HdlParse
-SOURCEDIR     = .
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = pyHDLParser
+PAPER         =
 BUILDDIR      = _build
 
-# Put it first so that "make" without argument is like "make help".
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees -T -D language=en $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+#---
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+
+#---
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+#---
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+
+#---
+
 .PHONY: help Makefile
 
 # 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)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/Makefile

@@ -0,0 +1,20 @@
+About
+#####
+
+Licensing
+---------
+
+pyHDLParser is distributed under the terms of the MIT license.
+
+Other projects
+--------------
+
+* `Evfs <https://kevinpt.github.io/evfs/>`__
+* `Guidoc <https://kevinpt.github.io/guidoc/>`__
+* `LeCroy-colorizer <http://kevinpt.github.io/lecroy-colorizer/>`__
+* `Opbasm <http://kevinpt.github.io/opbasm/>`__
+* `Ripyl <http://kevinpt.github.io/ripyl/>`__
+* `Symbolator <https://kevinpt.github.io/symbolator>`__
+* `Syntrax <https://kevinpt.github.io/syntrax>`__
+* `VerTcl <http://kevinpt.github.io/vertcl/>`__
+* `VHDL-extras <http://kevinpt.github.io/vhdl-extras/>`__