hello-world-service/documentation/sphinx/conf.py

62 lines
2.3 KiB
Python

# 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 sys
# sys.path.insert(0, os.path.abspath('.'))
_POM_PATH = "../.."
def getMvnVariable(variable):
cmd = """cd %s && mvn -q \
-Dexec.executable=echo \
-Dexec.args='${project.%s}' \
--non-recursive \
exec:exec""" % (_POM_PATH, variable)
stream = os.popen(cmd)
return stream.read().strip()
# -- Project information -----------------------------------------------------
# The full version, including alpha/beta/rc tags
release = getMvnVariable("version")
project = getMvnVariable("name")
copyright = '2024, %s' % getMvnVariable("organization.name")
author = 'Luca Frosini (ISTI-CNR), Lucio Lelii (ISTI-CNR), Alfredo Oliviero (ISTI-CNR)'
# -- 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 = []
# 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 = ['_build', 'Thumbs.db', '.DS_Store']
# -- 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 = 'sphinxdoc'
# 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 = ['_static']