Merge pull request #2 from VHDL/ci/docs

Updated CI Scripting and Documentation Publishing to GH-Pages

Author: Paebbels

.btd.yml

@@ -0,0 +1,8 @@
+input: doc
+output: _build
+requirements: requirements.txt
+target: gh-pages
+formats: [ html, pdf, man ]
+images:
+  latex: btdi/latex
+theme: https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v0

.github/workflows/doc.yml

@@ -0,0 +1,21 @@
+name: Doc
+
+on:
+  push:
+
+jobs:
+
+  btd:
+    runs-on: ubuntu-latest
+    steps:
+
+    - uses: actions/checkout@v2
+
+    - uses: buildthedocs/btd@v0
+      with:
+        token: ${{ github.token }}
+
+    - uses: actions/upload-artifact@master
+      with:
+        name: doc
+        path: doc/_build/html

.readthedocs.yml

@@ -0,0 +1,28 @@
+CP=cp
+
+# Sphinx options.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+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) .
+
+all: html latex
+
+#---
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+
+#---
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+#---
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

doc/Makefile

@@ -1,21 +1,17 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
+import sys, re
+from os.path import abspath
+from pathlib import Path
+from json import dump, loads
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('..'))
-sys.path.insert(0, os.path.abspath('../pyVHDLModel'))
-#sys.path.insert(0, os.path.abspath('_extensions'))
-#sys.path.insert(0, os.path.abspath('_themes/sphinx_rtd_theme'))
+sys.path.insert(0, abspath('.'))
+sys.path.insert(0, abspath('..'))
+sys.path.insert(0, abspath('../pyVHDLModel'))
+#sys.path.insert(0, abspath('_extensions'))
 
 
 # ==============================================================================
@@ -93,14 +89,27 @@ def _LatestTagName():
 # ==============================================================================
 # Options for HTML output
 # ==============================================================================
-# html_theme = 'alabaster'
-html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+    'home_breadcrumbs': True,
+    'vcs_pageview_mode': 'blob',
+}
+
+html_context = {}
+ctx = Path(__file__).resolve().parent / 'context.json'
+if ctx.is_file():
+    html_context.update(loads(ctx.open('r').read()))
+
+html_theme_path = ["."]
+html_theme = "_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyVHDLModelDoc'
+
 # If not None, a 'Last updated on:' timestamp is inserted at every page
 # bottom, using the given strftime format.
 # The empty string is equivalent to '%b %d, %Y'.
@@ -159,9 +168,6 @@ def _LatestTagName():
 # Extensions
 # ==============================================================================
 extensions = [
-# Sphinx theme
-	"sphinx_rtd_theme",
-
 # Standard Sphinx extensions
 	"sphinx.ext.autodoc",
 	'sphinx.ext.extlinks',

doc/conf.py

@@ -2,11 +2,8 @@
 # Enforce latest version on ReadTheDocs
 sphinx>=3.4.1
 
-# Sphinx Themes
-sphinx-rtd-theme>=0.5.0
-
 # Sphinx Extenstions
-sphinx.ext.coverage
+#sphinx.ext.coverage
 #sphinxcontrib-actdiag>=0.8.5
 #sphinxcontrib-seqdiag>=0.8.5
 #sphinxcontrib-textstyle>=0.2.1