|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | + |
| 3 | +import os |
| 4 | +import sys |
| 5 | +from pathlib import Path |
| 6 | + |
| 7 | +# -- Sphinx Options ----------------------------------------------------------- |
| 8 | + |
| 9 | +# If your project needs a minimal Sphinx version, state it here. |
| 10 | +needs_sphinx = "3.0" |
| 11 | + |
| 12 | +extensions = [ |
| 13 | + "sphinx.ext.extlinks", |
| 14 | + "sphinx.ext.intersphinx", |
| 15 | + "sphinx.ext.todo", |
| 16 | + "sphinxarg.ext", # Automatic argparse command line argument documentation |
| 17 | +] |
| 18 | + |
| 19 | +# The suffix(es) of source filenames. |
| 20 | +source_suffix = { |
| 21 | + ".rst": "restructuredtext" |
| 22 | +} |
| 23 | + |
| 24 | +master_doc = "index" |
| 25 | + |
| 26 | +project = u"Introduction to TDD and CI With VUnit" |
| 27 | +copyright = u"2014-2021, Lars Asplund" |
| 28 | +author = u"LarsAsplund and contributors" |
| 29 | + |
| 30 | +version = "" |
| 31 | +release = "" |
| 32 | + |
| 33 | +language = None |
| 34 | + |
| 35 | +exclude_patterns = [] |
| 36 | + |
| 37 | +pygments_style = "sphinx" |
| 38 | + |
| 39 | +todo_include_todos = False |
| 40 | + |
| 41 | +# -- Options for HTML output ---------------------------------------------- |
| 42 | + |
| 43 | +html_theme_path = ["."] |
| 44 | +html_theme = "_theme" |
| 45 | + |
| 46 | +html_theme_options = { |
| 47 | + "analytics_id": "UA-abcdefghi-j", |
| 48 | + "logo_only": True, |
| 49 | + "vcs_pageview_mode": "blob", |
| 50 | + "style_nav_header_background": "#0c479d", |
| 51 | + "home_breadcrumbs": False, |
| 52 | +} |
| 53 | +html_context = { |
| 54 | + "conf_py_path": "%s/" % Path(__file__).parent.name, |
| 55 | + "display_github": True, |
| 56 | + "github_user": "VUnit", |
| 57 | + "github_repo": "vunit", |
| 58 | + "github_version": "master/", |
| 59 | +} |
| 60 | + |
| 61 | +html_static_path = ["_static"] |
| 62 | + |
| 63 | +html_logo = str(Path(html_static_path[0]) / "VUnit_logo_175x175.png") |
| 64 | + |
| 65 | +html_favicon = str(Path(html_static_path[0]) / "vunit.ico") |
| 66 | + |
| 67 | +# Output file base name for HTML help builder. |
| 68 | +htmlhelp_basename = "VUnitDoc" |
| 69 | + |
| 70 | +# -- InterSphinx ---------------------------------------------------------- |
| 71 | + |
| 72 | +intersphinx_mapping = { |
| 73 | + "ghdl": ("https://ghdl.github.io/ghdl", None), |
| 74 | + "python": ("https://docs.python.org/3.8/", None), |
| 75 | + "vunit": ("https://vunit.github.io", None), |
| 76 | +} |
| 77 | + |
| 78 | +# -- ExtLinks ------------------------------------------------------------- |
| 79 | + |
| 80 | +extlinks = { |
| 81 | + "vunit_example": ("https://github.com/VUnit/vunit/tree/master/examples/%s/", ""), |
| 82 | + "vunit_file": ("https://github.com/VUnit/vunit/tree/master/%s/", ""), |
| 83 | + "vunit_commit": ("https://github.com/vunit/vunit/tree/%s/", "@"), |
| 84 | + "vunit_issue": ("https://github.com/VUnit/vunit/issues/%s/", "#"), |
| 85 | +} |
0 commit comments