ucast/docs/conf.py
ThetaDev fff882894f
All checks were successful
continuous-integration/drone/push Build is passing
add sphinx project
2022-06-29 22:41:57 +02:00

92 lines
2.9 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('../code'))
# -- Project information -----------------------------------------------------
project = "Ucast"
subtitle = "Projektarbeit Webtechnologien"
author = "Thomas Hampp"
copyright = "2022 " + author
examiner = "Fabian Ziegler"
deadline = "09.07.2022"
course = "Master Informatik"
# -- 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 = [
"sphinxcontrib.cairosvgconverter",
]
# 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 = [".tox"]
# Pygments-Styling used for code syntax highlighting.
# See this page for an overview of all styles including live demo:
# https://pygments.org/demo/
pygments_style = "vs"
# -- 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"
# 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"]
# -- Options for PDF output -------------------------------------------------
latex_engine = "xelatex"
# latex_theme = 'hsathesis'
latex_elements = {
"extraclassoptions": "openany,oneside",
"preamble": r"""
\usepackage{hsastyle}
\newcommand\subtitle{%s}
\newcommand\deadline{%s}
\newcommand\examiner{%s}
\newcommand\hscourse{%s}
"""
% (subtitle, deadline, examiner, course),
"maketitle": r"\hsamaketitle",
}
latex_additional_files = [
"_latex/logos/hsa_informatik_logo_lq.pdf",
"_latex/hsastyle.sty",
]