conf.py

# 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 = 'Title'
copyright = '2023, Author'
author = 'Author'
titlepage = {
        "title": "Praca",
        "subtitle":"Tytuł pracy",
        "subtitle2":"Document Title",
        "author": author,
        "profile": "Fizyka Techniczna",
        "protector": "Opiekun",
        "townAndYear": "Kraków 2024",
}

# for cloud_sptheme.ext.issue_tracker
issue_tracker_url="gh:gucio321/fizyka"

# -- 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 = [
        "sphinx.ext.githubpages",
        "sphinxcontrib.images", # https://github.com/sphinx-contrib/images
        "sphinxcontrib.plot",
        #"cloud_sptheme.ext.issue_tracker",
        "myst_parser" # ref: https://www.sphinx-doc.org/en/master/usage/markdown.html
]

# 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 = 'pl'

# 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 = ['docs', 'Thumbs.db', '.DS_Store', '_build', 'venv', "README.md", "assets/README.md"]

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
# more themes: https://sphinx-themes.org/#theme-groundwork-sphinx-theme
html_theme = 'cloud'
html_theme_options = {
        "sidebar_localtoc_title": "Spis treści:",
        "sidebar_prev_title": "Poprzednia strona",
        "sidebar_next_title": "Następna strona",
}
html_css_files= [
        'css/custom.css'
]

# 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']

html_logo = "./assets/logo.png"
html_favicon = "./assets/icon.ico"
#TODO: add something better
#html_permalinks_icon=
html_copy_source=False

# for myst_parser (markdown)
myst_enable_extensions = [
    "amsmath",
    "attrs_inline",
    "colon_fence",
    "deflist",
    "dollarmath",
    "fieldlist",
    "html_admonition",
    "html_image",
    #"linkify",
    "replacements",
    "smartquotes",
    "strikethrough",
    "substitution",
    "tasklist",
]

# just helper :-P
def defineLatexVar(varName : str, var : str) -> str:
    if var == None or var == "":
        return ""

    return r'\newcommand{' + varName + r'}{' + var + "}"

latex_additional_files = ['resources/titlepage.cls', 'resources/logo_AGH.jpg']
latex_elements = {
        'papersize': 'letterpaper',
        'pointsize': '10pt',
        'preamble': r'''
        \usepackage{cancel}
        \usepackage[utf8]{inputenc}
        %%\usepackage[margin=3.5cm]{geometry}
        \usepackage{graphicx}
        \newcommand{\sphinxDocumentTitle}{'''+titlepage['title']+r'''}
        \newcommand{\sphinxDocumentSubtitle}{'''+titlepage['subtitle']+r'''}
        \newcommand{\sphinxDocumentSubtitleBis}{'''+titlepage['subtitle2']+r'''}
        \newcommand{\sphinxDocumentAuthor}{'''+titlepage['author']+r'''}
        ''' + defineLatexVar("\sphinxDocumentProfile", titlepage['profile']) + r'''
        ''' + defineLatexVar("\sphinxDocumentProtector", titlepage['protector']) + r'''
        ''' + defineLatexVar("\sphinxDocumentTownAndYear", titlepage['townAndYear']) + r'''
        ''',
        'maketitle': '\\input{titlepage.cls}'
}