77 lines
2.4 KiB
Python
77 lines
2.4 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('.'))
|
|
#sys.path.insert(0, os.path.abspath('..'))
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'Manual'
|
|
copyright = '2022, Stefan Ingenieur Begerad (SIB)'
|
|
author = 'Contributors'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = '0.1.0'
|
|
|
|
# -- 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 = [
|
|
'myst_parser'
|
|
]
|
|
|
|
# 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 = 'en'
|
|
|
|
# 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 = []
|
|
|
|
myst_url_schemes = ['http', 'https', 'mailto', 'ftp', 'mumble']
|
|
|
|
|
|
# -- Options for LaTex output -------------------------------------------------
|
|
|
|
latex_elements = {
|
|
'papersize': r'a4paper',
|
|
'fontpkg': r'''
|
|
\usepackage[default]{lato}
|
|
%\setmainfont{DejaVu Serif}
|
|
%\setsansfont{DejaVu Sans}
|
|
%\setmonofont{DejaVu Sans Mono}
|
|
''',
|
|
'preamble': r'''
|
|
\usepackage[titles]{tocloft}
|
|
\cftsetpnumwidth {1.25cm}\cftsetrmarg{1.5cm}
|
|
\setlength{\cftchapnumwidth}{0.75cm}
|
|
\setlength{\cftsecindent}{\cftchapnumwidth}
|
|
\setlength{\cftsecnumwidth}{1.25cm}
|
|
''',
|
|
'fncychap': r'\usepackage[Bjornstrup]{fncychap}',
|
|
'printindex': r'\footnotesize\raggedright\printindex',
|
|
}
|
|
latex_show_urls = 'footnote'
|