| """Configuration file for the Sphinx documentation builder.""" | |
| # -- 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 = "socceraction" | |
| copyright = "2020, DTAI KU Leuven" | |
| author = "Tom Decroos" | |
| # The full version, including alpha/beta/rc tags | |
| release = "1.5.3" | |
| # -- 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.napoleon", | |
| "sphinx.ext.autodoc", | |
| "sphinx_autodoc_typehints", | |
| "sphinx.ext.autosummary", | |
| "sphinx.ext.intersphinx", | |
| ] | |
| autodoc_member_order = "bysource" | |
| autosummary_generate = True | |
| # Add any paths that contain templates here, relative to this directory. | |
| templates_path = ["_templates"] | |
| # 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 = "furo" | |
| pygments_style = "friendly" | |
| html_logo = "_static/logo_white.png" | |
| html_favicon = "_static/favicon.png" | |
| html_theme_options = { | |
| "sidebar_hide_name": True, | |
| "light_css_variables": { | |
| "color-brand-primary": "#26b079", | |
| "color-brand-content": "#26b079", | |
| "color-api-highlight-on-target": "#e5fff5", | |
| }, | |
| "dark_css_variables": { | |
| "color-brand-primary": "#26b079", | |
| "color-brand-content": "#26b079", | |
| "color-api-highlight-on-target": "#e5fff5", | |
| }, | |
| } | |
| # 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_css_files = ["custom.css"] | |