mirror of
https://gitlab.freedesktop.org/pipewire/wireplumber.git
synced 2025-12-20 04:10:03 +01:00
a5e58536dd
Add comprehensive wpctl documentation that generates both HTML docs and an installable man page from a single RST source. Closes: #825 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
55 lines
1.3 KiB
Python
55 lines
1.3 KiB
Python
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'WirePlumber'
|
|
copyright = '2021-2024, Collabora'
|
|
author = 'Collabora'
|
|
release = '@VERSION@'
|
|
version = '@VERSION@'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
smartquotes = False
|
|
|
|
# -- Breathe configuration ---------------------------------------------------
|
|
|
|
extensions = [
|
|
'breathe',
|
|
'sphinx_rtd_theme',
|
|
'sphinx.ext.graphviz',
|
|
]
|
|
|
|
breathe_projects = {
|
|
"WirePlumber": "@OUTDIR@/wp/xml",
|
|
}
|
|
breathe_default_project = "WirePlumber"
|
|
breathe_default_members = ('members', 'undoc-members')
|
|
|
|
breathe_domain_by_extension = {
|
|
"h" : "c",
|
|
"c" : "c",
|
|
}
|
|
breathe_show_define_initializer = True
|
|
breathe_show_enumvalue_initializer = True
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
html_theme_options = {
|
|
"display_version": True,
|
|
"prev_next_buttons_location": "both",
|
|
"style_external_links": True,
|
|
}
|
|
|
|
html_static_path = ['@SRCDIR@/_static']
|
|
html_css_files = ['custom.css']
|
|
|
|
graphviz_output_format = "svg"
|
|
|
|
pygments_style = "friendly"
|
|
|
|
# -- Options for manual page output -----------------------------------------
|
|
|
|
man_pages = [
|
|
('tools/wpctl', 'wpctl', 'WirePlumber Control CLI', ['The WirePlumber Developers'], 1)
|
|
]
|