File size: 2,559 Bytes
2d6bfa0 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# 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 --------------------------------------------------------------
# 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 subprocess
# sys.path.insert(0, os.path.abspath('.'))
current_file_dir = os.path.dirname(os.path.realpath(__file__))
def get_git_short_hash():
rc = subprocess.check_output(["git", "rev-parse", "--short", "HEAD"])
rc = rc.decode("utf-8").strip()
return rc
# -- Project information -----------------------------------------------------
project = "MAS Industrial Robotics"
copyright = "2022, www.b-it-bots.de"
author = "www.b-it-bots.de"
# The full version, including alpha/beta/rc tags
# current_hash = get_git_short_hash()
current_hash = "Noetic"
version = "latest ({})".format(current_hash)
release = version
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["sphinx.ext.autodoc"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
theme_path = os.path.join(
current_file_dir, "..", "..", "third_party", "sphinx_rtd_theme"
)
html_theme_path = [
theme_path,
]
# 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 = []
# Master document should be index.rst instead of contents.rst
# https://github.com/readthedocs/readthedocs.org/issues/2569#issuecomment-485117471
master_doc = "index"
|