spiri-sdk/docs/source/conf.py

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import sphinx_rtd_theme

project = "spiri-sdk"
copyright = "2024, Spiri Robotics"
author = "Spiri Robotics"

html_logo = "logos/SPIRI_STLockup_Mixed_RGB.png"  # For HTML output
html_logo_width = '200px' 
latex_logo = "logos/SPIRI_STLockup_Mixed_RGB.png"
latex_logo_width = '5cm'


# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    "myst_parser",
    "sphinx.ext.duration",
    "sphinx.ext.doctest",
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.intersphinx",
    "sphinx.ext.todo",
]


numfig = True

todo_include_todos = True
todo_emit_warnings = True
todo_link_only = True


templates_path = ["_templates"]
exclude_patterns = []

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

html_static_path = ['_static']

html_css_files = [
    'custom.css',
]


html_theme_options = {
    'collapse_navigation': True,
    'sticky_navigation': True,
    'navigation_depth': 4, #could be set to -1 if we want unlimited depth
    'includehidden': True,
    'titles_only': False
}

latex_engine = "xelatex"
# Configure LaTeX options for PDF generation
latex_show_urls = 'footnote'