Commit 32200da5 authored by George Kiagiadakis's avatar George Kiagiadakis
Browse files

docs: improve the visual appearence of the generated html and cleanup

parent 2eac6257
/* expand to full window width */
.wy-nav-content {
max-width: none;
}
/* style function names */
.rst-content .sig-name .n {
color: #000;
padding-left: 0.3em;
}
/* style parenthesis in function signatures */
.rst-content .sig-paren {
padding: 0.3em;
}
/* space between pointer symbols and variable names:
ex: WpObject *<-padding->self */
.rst-content .sig span.p+span.n {
padding-left: 0.3em;
}
/* space between macro names and their definitions:
ex: FOO_TYPE_BAR<-padding->(foo_bar_get_type()) */
.rst-content .sig-name+.pre {
padding-left: 0.5em;
}
/* hack for gobject properties, which are marked as cpp signatures */
.rst-content .sig.sig-object.cpp {
padding-left: 0.3em;
}
div.graphviz {
padding-top: 1em;
padding-bottom: 1em;
}
# 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 = 'WirePlumber'
......@@ -25,52 +8,39 @@ author = 'Collabora'
release = '@VERSION@'
# -- General configuration ---------------------------------------------------
# -- Breathe 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',
'sphinx_rtd_theme',
'breathe',
'sphinx_rtd_theme',
]
breathe_projects = {
"WirePlumber": "@OUTDIR@/wp/xml",
"WirePlumber_Lua" : "@OUTDIR@/lua/xml",
}
breathe_default_members = ('members', 'undoc-members')
breathe_default_project = "WirePlumber"
# Exclude '.c' extension from breathe_implementation_filename_extensions so that the documented code in C files is parsed and the ReStructured Text files are built from xml files
breathe_implementation_filename_extensions = ['.cc', '.cpp']
breathe_default_members = ('members', 'protected-members', 'undoc-members')
# Let breathe know that our domain is 'C'
primary_domain = 'c'
breathe_domain_by_extension = {
"h" : "c",
"c" : "c",
}
# See, https://breathe.readthedocs.io/en/latest/directives.html#config-values for more information
# 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 = ['meson.build']
breathe_show_define_initializer = True
breathe_show_enumvalue_initializer = True
# -- Options for HTML output -------------------------------------------------
html_theme = 'sphinx_rtd_theme'
html_theme = "sphinx_rtd_theme"
# 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_theme_options = {
"display_version": True,
"prev_next_buttons_location": "both",
"style_external_links": True,
"style_nav_header_background": "#729fcf",
}
# Tell sphinx what the primary language being documented is.
primary_domain = 'c'
html_static_path = ['@SRCDIR@/_static']
html_css_files = ['custom.css']
......@@ -74,10 +74,11 @@ if build_doc
build_by_default: true,
)
sphinx_files = []
sphinx_files = files('_static'/'custom.css')
subdir('rst')
sphinx_conf_data = configuration_data()
sphinx_conf_data.set('SRCDIR', meson.current_source_dir())
sphinx_conf_data.set('OUTDIR', meson.current_build_dir())
sphinx_conf_data.set('VERSION', meson.project_version())
sphinx_conf = configure_file(
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment