mirror of https://github.com/avast/PurpleDome
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
105 lines
3.0 KiB
Python
105 lines
3.0 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('.'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'PurpleDome Intro'
|
|
copyright = '2022, Thorsten Sick'
|
|
author = 'Thorsten Sick'
|
|
|
|
|
|
# -- 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 = [
|
|
]
|
|
|
|
# Reveal JS
|
|
|
|
extensions += [
|
|
"sphinx_revealjs",
|
|
]
|
|
|
|
# -- Options for Reveal.js output ---------------------------------------------
|
|
revealjs_static_path = ["_static"]
|
|
revealjs_google_fonts = ["M PLUS 1p", ]
|
|
revealjs_style_theme = "black"
|
|
revealjs_script_conf = {
|
|
"controls": True,
|
|
"progress": True,
|
|
"history": True,
|
|
"center": True,
|
|
"transition": "slide",
|
|
"slideNumber": False
|
|
}
|
|
revealjs_script_plugins = [
|
|
{
|
|
"name": "RevealNotes",
|
|
"src": "revealjs4/plugin/notes/notes.js",
|
|
},
|
|
{
|
|
"name": "RevealHighlight",
|
|
"src": "revealjs4/plugin/highlight/highlight.js",
|
|
},
|
|
{
|
|
"name": "RevealMath",
|
|
"src": "revealjs4/plugin/math/math.js",
|
|
},
|
|
]
|
|
revealjs_css_files = [
|
|
"revealjs4/plugin/highlight/zenburn.css",
|
|
"mod.css",
|
|
]
|
|
|
|
# Graphviz
|
|
extensions += [
|
|
"sphinx.ext.graphviz"
|
|
]
|
|
|
|
# -- GraphViz configuration ----------------------------------
|
|
graphviz_output_format = 'svg'
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# 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 = 'de'
|
|
|
|
# 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 = 'alabaster'
|
|
|
|
# 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']
|