docs: add btd.yml and Makefile

Author: rodrigomelo9

.btd.yml

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

docs/Makefile

@@ -0,0 +1,23 @@
+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) .
+
+#---
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+
+#---
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+#---
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

docs/conf.py

@@ -13,8 +13,7 @@
 extensions = [
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
-    "sphinx.ext.todo",
-    "sphinxarg.ext",  # Automatic argparse command line argument documentation
+    "sphinx.ext.todo"
 ]
 
 # The suffix(es) of source filenames.
@@ -24,7 +23,7 @@
 
 master_doc = "index"
 
-project = u"Introduction to TDD and CI With VUnit"
+project = u"VUnit: Introduction to TDD and CI"
 copyright = u"2014-2021, Lars Asplund"
 author = u"LarsAsplund and contributors"
 
@@ -52,6 +51,7 @@
     "home_breadcrumbs": False,
 }
 
+html_context = {}
 ctx = Path(__file__).resolve().parent / 'context.json'
 if ctx.is_file():
     html_context.update(loads(ctx.open('r').read()))
@@ -79,6 +79,9 @@
 extlinks = {
     "vunit_example": ("https://github.com/VUnit/vunit/tree/master/examples/%s/", ""),
     "vunit_file": ("https://github.com/VUnit/vunit/tree/master/%s/", ""),
-    "vunit_commit": ("https://github.com/vunit/vunit/tree/%s/", "@"),
+    "vunit_commit": ("https://github.com/VUnit/vunit/tree/%s/", "@"),
     "vunit_issue": ("https://github.com/VUnit/vunit/issues/%s/", "#"),
+    "tdd_file": ("https://github.com/VUnit/tdd-intro/tree/master/%s/", ""),
+    "tdd_commit": ("https://github.com/VUnit/tdd-intro/tree/%s/", "@"),
+    "tdd_issue": ("https://github.com/VUnit/tdd-intro/issues/%s/", "#"),
 }

docs/index.rst

@@ -1,8 +1,11 @@
 
-.. centered:: |shieldRepo|_ |shieldGitter|_ |shieldTwitter|_
+.. centered:: |shieldTdd|_ |shieldVunit|_ |shieldGitter|_ |shieldTwitter|_
 
-.. |shieldRepo| image:: https://img.shields.io/badge/VUnit/vunit-0c479d.svg?longCache=true&style=flat-square&logo=github
-.. _shieldRepo: https://github.com/VUnit/tdd-intro
+.. |shieldTdd| image:: https://img.shields.io/badge/VUnit/tdd--intro-0c479d.svg?longCache=true&style=flat-square&logo=github
+.. _shieldTdd: https://github.com/VUnit/tdd-intro
+
+.. |shieldVunit| image:: https://img.shields.io/badge/VUnit/vunit-0c479d.svg?longCache=true&style=flat-square&logo=github
+.. _shieldVunit: https://github.com/VUnit/vunit
 
 .. |shieldGitter| image:: https://img.shields.io/gitter/room/VUnit/vunit.svg?longCache=true&style=flat-square&logo=gitter&logoColor=4db797&color=4db797
 .. _shieldGitter: https://gitter.im/VUnit/vunit