conf.py

import pathlib
import subprocess

doxy_list = [
    "fri.Doxyfile",
    "lbr_fri_ros2.Doxyfile",  # lbr_fri_ros2.Doxyfile requires tagfile of fri.Doxyfile
]

for doxyfile in doxy_list:
    doxyfile_name = doxyfile.split(".")[0]

    # generate doxygen
    path = pathlib.Path(f"docs/doxygen/{doxyfile_name}")
    if not path.exists():
        path.mkdir(parents=True)  # this is the doxygen OUTPUT_DIRECTORY
    subprocess.run(f"doxygen {doxyfile}", shell=True)

    # convert doxygen to sphinx, source and build directory need
    # to follow https://boschglobal.github.io/doxysphinx/docs/getting_started.html#build
    subprocess.run(
        f"doxysphinx build . $READTHEDOCS_OUTPUT/html {doxyfile}", shell=True
    )

# 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

project = "LBR-Stack"
copyright = "2024, mhubii"
author = "mhubii"
release = "2.0.0"

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

extensions = [
    "myst_parser",
    "sphinx.ext.autosectionlabel",
    "sphinx_copybutton",
    "sphinx_design",
    "sphinx_markdown_tables",
    "sphinx_panels",
    "sphinxcontrib.doxylink",
    "sphinxcontrib.images",
]

templates_path = ["_templates"]
exclude_patterns = ["links.rst"]

# Doxylink
doxygen_root = "docs/doxygen"
doxylink = {
    "fri": (
        f"{doxygen_root}/fri/html/tagfile.xml",
        f"{doxygen_root}/fri/html",
    ),
    "lbr_fri_ros2": (
        f"{doxygen_root}/lbr_fri_ros2/html/tagfile.xml",
        f"{doxygen_root}/lbr_fri_ros2/html",
    ),
}

# Make rst_epilog a variable, so you can add other epilog parts to it
rst_epilog = ""

# Read link all targets from file
with open("docs/links.rst") as f:
    rst_epilog += f.read()

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

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

html_theme = "sphinx_rtd_theme"
html_logo = "../img/logo.png"