ci: add a workflow for docs based on the BTD action

Author: rodrigomelo9

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: Docs
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+
+  BuildTheDocs:
+    name: BuildTheDocs
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: 'Checkout'
+        uses: actions/checkout@v2
+
+      - name: 'Run BuildTheDocs and publish to GitHub Pages'
+        uses: buildthedocs/btd@v0
+        with:
+          token: ${{ github.token }}
+
+      - name: 'Upload artifacts'
+        uses: actions/upload-artifact@master
+        with:
+          name: doc
+          path: docs/_build/html

docs/conf.py

@@ -2,6 +2,7 @@
 
 import os
 import sys
+from json import loads
 from pathlib import Path
 
 # -- Sphinx Options -----------------------------------------------------------
@@ -50,13 +51,11 @@
     "style_nav_header_background": "#0c479d",
     "home_breadcrumbs": False,
 }
-html_context = {
-    "conf_py_path": "%s/" % Path(__file__).parent.name,
-    "display_github": True,
-    "github_user": "VUnit",
-    "github_repo": "vunit",
-    "github_version": "master/",
-}
+
+ctx = Path(__file__).resolve().parent / 'context.json'
+if ctx.is_file():
+    html_context.update(loads(ctx.open('r').read()))
+
 
 html_static_path = ["_static"]