mirror of
https://github.com/projectM-visualizer/projectm.git
synced 2025-12-01 12:11:20 +00:00
102 lines
3.4 KiB
Python
102 lines
3.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('.'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'libprojectM'
|
|
copyright = '2024, libprojectM committers'
|
|
author = 'libprojectM committers'
|
|
|
|
# The short X.Y version
|
|
version = '4.1.0'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = '4.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 = [
|
|
'breathe',
|
|
'exhale',
|
|
]
|
|
|
|
# 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 = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
|
|
# Setup the exhale extension
|
|
exhale_args = {
|
|
# These arguments are required
|
|
"containmentFolder": "../../projectm/docs/api",
|
|
"rootFileName": "library_root.rst",
|
|
"doxygenStripFromPath": "..",
|
|
# Heavily encouraged optional argument (see docs)
|
|
"rootFileTitle": "ProjectM API",
|
|
# Suggested optional arguments
|
|
"createTreeView": True,
|
|
# TIP: if using the sphinx-bootstrap-theme, you need
|
|
# "treeViewIsBootstrap": True,
|
|
"exhaleExecutesDoxygen": False,
|
|
}
|
|
|
|
# Tell sphinx what the primary language being documented is.
|
|
primary_domain = 'cpp'
|
|
|
|
# Tell sphinx what the pygments highlight language should be.
|
|
highlight_language = 'cpp'
|
|
|
|
# Tell sphinx about the export attributes we use:
|
|
cpp_id_attributes = ["PROJECTM_EXPORT", "PROJECTM_PLAYLIST_EXPORT"]
|
|
|
|
# -- 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 = 'alabaster'
|
|
|
|
# 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_context = {
|
|
'display_github': True,
|
|
'github_user': 'projectM-visualizer',
|
|
'github_repo': 'projectm',
|
|
'github_version': 'master'
|
|
}
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
breathe_projects = { "projectm_doxygen": "/home/dwagner/git/cmake-build-projectm/xml" }
|
|
breathe_default_project = 'projectm_doxygen' |