docs: add infrastructure taken from the Vunit main project

Author: rodrigomelo9

.github/build_docs.py

@@ -0,0 +1,59 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Copyright (c) 2014-2021, Lars Asplund [email protected]
+
+"""
+Command line utility to build documentation/website
+"""
+
+from subprocess import check_call
+from pathlib import Path
+import sys
+from sys import argv
+from shutil import copyfile
+
+
+DROOT = Path(__file__).parent.parent / 'docs'
+
+
+def get_theme(path: Path, url: str):
+    """
+    Check if the theme is available locally, retrieve it with curl and tar otherwise
+    """
+    tpath = path / "_theme"
+    if not tpath.is_dir() or not (tpath / "theme.conf").is_file():
+        if not tpath.is_dir():
+            tpath.mkdir()
+        zpath = path / "theme.tgz"
+        if not zpath.is_file():
+            check_call(["curl", "-fsSL", url, "-o", str(zpath)])
+        tar_cmd = ["tar", "--strip-components=1", "-C", str(tpath), "-xvzf", str(zpath)]
+        check_call(tar_cmd)
+
+
+def main():
+    """
+    Build documentation/website
+    """
+    get_theme(
+        DROOT,
+        "https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v0"
+    )
+    check_call(
+        [
+            sys.executable,
+            "-m",
+            "sphinx"
+        ] + ([] if len(argv) < 2 else argv[2:]) + [
+            "-TEWanb",
+            "html",
+            Path(__file__).parent.parent / "docs",
+            argv[1],
+        ]
+    )
+
+
+if __name__ == "__main__":
+    main()

.gitignore

@@ -0,0 +1,3 @@
+/docs/_build
+/docs/_theme
+*.tgz

docs/_static/VUnit_logo_175x175.png

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+from pathlib import Path
+
+# -- Sphinx Options -----------------------------------------------------------
+
+# If your project needs a minimal Sphinx version, state it here.
+needs_sphinx = "3.0"
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinxarg.ext",  # Automatic argparse command line argument documentation
+]
+
+autodoc_default_options = {
+    "members": True,
+}
+
+# The suffix(es) of source filenames.
+source_suffix = {
+    ".rst": "restructuredtext",
+    # '.txt': 'markdown',
+    # '.md': 'markdown',
+}
+
+master_doc = "index"
+
+project = u"Introduction to TDD and CI With VUnit"
+copyright = u"2014-2021, Lars Asplund"
+author = u"LarsAsplund, kraigher and contributors"
+
+version = ""
+release = ""
+
+language = None
+
+exclude_patterns = []
+
+pygments_style = "sphinx"
+
+todo_include_todos = False
+
+# -- Options for HTML output ----------------------------------------------
+
+html_theme_path = ["."]
+html_theme = "_theme"
+
+html_theme_options = {
+    "analytics_id": "UA-abcdefghi-j",
+    "logo_only": True,
+    "vcs_pageview_mode": "blob",
+    "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/",
+}
+
+html_static_path = ["_static"]
+
+html_logo = str(Path(html_static_path[0]) / "VUnit_logo_175x175.png")
+
+html_favicon = str(Path(html_static_path[0]) / "vunit.ico")
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "VUnitDoc"
+
+# -- InterSphinx ----------------------------------------------------------
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.8/", None),
+}
+
+# -- ExtLinks -------------------------------------------------------------
+
+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_issue": ("https://github.com/VUnit/vunit/issues/%s/", "#"),
+}

docs/_static/VUnit_logo_420x420.png

@@ -0,0 +1,22 @@
+
+.. centered:: |shieldRepo|_ |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
+
+.. |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
+
+.. |shieldTwitter| image:: https://img.shields.io/twitter/follow/VUnitFramework.svg?longCache=true&style=flat-square&color=1DA1F2&label=%40VUnitFramework&logo=twitter&logoColor=fff
+.. _shieldTwitter: https://www.twitter.com/VUnitFramework
+
+Introduction to Test-Driven Development and Continuous Integration With VUnit
+=============================================================================
+
+.. toctree::
+   :caption: TDD tutorial
+   :hidden:
+
+.. toctree::
+   :caption: CI tutorial
+   :hidden: