143 lines
4.5 KiB
Python
143 lines
4.5 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# This file is execfile()d with the current directory set to its
|
|
# containing dir.
|
|
#
|
|
# Note that not all possible configuration values are present in this
|
|
# autogenerated file.
|
|
#
|
|
# All configuration values have a default; values that are commented out
|
|
# serve to show the default.
|
|
|
|
# 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('.'))
|
|
|
|
import os
|
|
import toml
|
|
import subprocess
|
|
|
|
current_path = os.path.abspath('.')
|
|
project_config = toml.load('config.toml')
|
|
project_version = subprocess.check_output(
|
|
['git', 'rev-parse', '--short', 'HEAD']
|
|
).decode('ascii').strip()
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
# General information about the project.
|
|
project = project_config['name']
|
|
copyright = project_config['copyright']
|
|
author = project_config['author']
|
|
description_formatted = project_config['description_formatted']
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
#
|
|
# needs_sphinx = '1.0'
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = ['sphinxcontrib.plantuml', 'myst_parser']
|
|
|
|
# plantuml config
|
|
project_plantuml_config_path = '{}/{}'.format(
|
|
current_path, project_config['plantuml_config']
|
|
)
|
|
plantuml = 'plantuml -config "{}"'.format(
|
|
project_plantuml_config_path,
|
|
)
|
|
plantuml_output_format = 'svg_img'
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = []
|
|
|
|
# The suffix(es) of source filenames.
|
|
# You can specify multiple suffix as a list of string:
|
|
#
|
|
# source_suffix = ['.rst', '.md']
|
|
source_suffix = {
|
|
'.md': 'markdown',
|
|
'.rst': 'restructuredtext',
|
|
}
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
#
|
|
# The short X.Y version.
|
|
version = project_version
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = version
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = 'en'
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This patterns also effect to html_static_path and html_extra_path
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'colorful'
|
|
|
|
# The name of a reST role to use as the default role, that is, for text marked
|
|
# up `like this`. The default role can always be set within individual
|
|
# documents using the standard reST default-role directive.
|
|
default_role = 'any'
|
|
|
|
# The default language to highlight source code.
|
|
highlight_language = 'rst'
|
|
|
|
# -- 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 = 'alabaster'
|
|
|
|
# Theme options are theme-specific and customize the look and feel of a theme
|
|
# further. For a list of options available for each theme, see the
|
|
# documentation.
|
|
#
|
|
# html_theme_options = {}
|
|
|
|
html_theme_options = {
|
|
'font_family': 'Inconsolata',
|
|
'font_size': '16px',
|
|
'show_powered_by': 'false',
|
|
'description': eval(f"f'{description_formatted}'"),
|
|
'show_related': True,
|
|
}
|
|
|
|
# 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 = [f'{current_path}/_static']
|
|
|
|
# Custom sidebar templates, must be a dictionary that maps document names
|
|
# to template names.
|
|
#
|
|
# This is required for the alabaster theme
|
|
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
|
html_sidebars = {
|
|
'**': [
|
|
'about.html',
|
|
'navigation.html',
|
|
'relations.html', # needs 'show_related': True theme option to display
|
|
'searchbox.html',
|
|
]
|
|
}
|