doc/source/conf.py - main - githubmirror/rsyslog

doc/source/conf.py
808 строк28 KB
Rainer Gerhards
doc/release: prevent invalid release version manual change
25 июн 2026, 16:05
25 июн 2026, 16:0584be397
# -*- coding: utf-8 -*-
#
# Rsyslog Doc documentation build configuration file, created by
# sphinx-quickstart on Sun Apr 28 07:10:10 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import importlib
import json
import os
import re
import sys
from urllib.parse import urljoin

from docutils import nodes

# Module for our custom functions. Used with automating build info.
sys.path.append(os.getcwd())
import conf_helpers  # noqa: E402

# 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.
sys.path.insert(0, os.path.abspath('_ext'))

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '4.5.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['edit_on_github',
              'sphinx.ext.todo',
              'rsyslog_lexer',
              'sphinxcontrib.mermaid',
              ]
edit_on_github_project = 'https://github.com/rsyslog/rsyslog'
edit_on_github_branch = 'main'

# Configure local copies of the JavaScript assets that power the Mermaid
# diagrams so that the generated HTML does not fetch files from a CDN.
#
# Design choice: UMD (mermaid.min.js) over ESM for file:// support.
# ES modules are blocked by CORS when opening HTML via file:// (browser security).
# Using UMD + monkey-patch to strip type="module" allows offline viewing.
# Trade-off: ELK layout is not available in offline mode (fix-mermaid-offline.py
# removes the ELK script tag). For HTTP-served docs, ELK would work with ESM;
# we prioritize file:// compatibility so built docs work without a local server.
MERMAID_JS_PATH = 'vendor/mermaid/mermaid.min.js'
MERMAID_ELK_JS_PATH = 'vendor/mermaid/mermaid-layout-elk.esm.min.mjs'  # Stripped by fix script for file://
D3_JS_PATH = 'vendor/d3/d3.min.js'

mermaid_use_local = MERMAID_JS_PATH
mermaid_elk_use_local = MERMAID_ELK_JS_PATH
d3_use_local = D3_JS_PATH

mermaid_init_js = ""

try:
    import sphinxcontrib.mermaid as _sphinx_mermaid  # type: ignore
except Exception:  # pragma: no cover - fallback for doc builds without the extension
    pass
else:
    _sphinx_mermaid._MERMAID_RUN_NO_D3_ZOOM = """
window.addEventListener("load", () => {{
    if (typeof mermaid !== 'undefined') {{
        mermaid.run();
    }}
}});
""".strip()

    _sphinx_mermaid._MERMAID_RUN_D3_ZOOM = """
window.addEventListener("load", () => {{
    if (typeof mermaid !== 'undefined' && typeof d3 !== 'undefined') {{
        mermaid.run();
        const all_mermaids = document.querySelectorAll(".mermaid");
        const mermaids_to_add_zoom = {d3_node_count} === -1 ? all_mermaids.length : {d3_node_count};
        const mermaids_processed = document.querySelectorAll(".mermaid[data-processed='true']");
        if (mermaids_to_add_zoom > 0) {{
            const svgs = d3.selectAll("{d3_selector}");
            function addZoomToSvgs(svgs) {{
                svgs.each(function() {{
                    const svg = d3.select(this);
                    svg.html("<g class='wrapper'>" + svg.html() + "</g>");
                    const inner = svg.select("g");
                    const zoom = d3.zoom().on("zoom", function(event) {{
                        inner.attr("transform", event.transform);
                    }});
                    svg.call(zoom);
                }});
            }}
            if (all_mermaids.length !== mermaids_processed.length || svgs.size() !== mermaids_to_add_zoom) {{
                function waitForSvgsReady() {{
                    const svgs = d3.selectAll("{d3_selector}");
                    if (svgs.size() !== mermaids_to_add_zoom) {{
                        setTimeout(waitForSvgsReady, 200);
                        return;
                    }}
                    addZoomToSvgs(svgs);
                }}
                setTimeout(waitForSvgsReady, 200);
                return;
            }} else {{
                addZoomToSvgs(svgs);
            }}
        }}
    }}
}});
""".strip()

    mermaid_init_js = """
window.addEventListener("load", () => {
    if (typeof mermaid !== 'undefined') {
        // Force Dagre renderer; ELK is not available in non-module builds (CORS with file://)
        mermaid.initialize({
            startOnLoad: false,
            flowchart: { defaultRenderer: 'dagre' }
        });
    }
});
""".strip()

    _original_install_js = _sphinx_mermaid.install_js

    def _vendored_install_js(app, *args, **kwargs):
        """Force sphinxcontrib-mermaid to load the vendored UMD JavaScript (file:// compatible)."""

        app.config.mermaid_use_local = MERMAID_JS_PATH
        app.config.mermaid_elk_use_local = MERMAID_ELK_JS_PATH
        app.config.d3_use_local = D3_JS_PATH
        app.config.mermaid_init_js = mermaid_init_js

        original_add_js_file = app.add_js_file

        def _intercept_add_js_file(filename, **file_kwargs):
            # Remove type=module from UMD mermaid script so it works with file:// URLs
            if filename and any(vendor_path in filename for vendor_path in [MERMAID_JS_PATH, MERMAID_ELK_JS_PATH]):
                if 'mermaid' in filename and not filename.endswith('.mjs'):
                    file_kwargs.pop('type', None)
                    file_kwargs.pop('async', None)
            return original_add_js_file(filename, **file_kwargs)

        try:
            app.add_js_file = _intercept_add_js_file  # type: ignore[assignment]
            return _original_install_js(app, *args, **kwargs)
        finally:
            app.add_js_file = original_add_js_file  # type: ignore[assignment]

    _sphinx_mermaid.install_js = _vendored_install_js

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'rsyslog'
copyright = u'2008-2026, Rainer Gerhards and Others'
author = u'Rainer Gerhards and Others'


# https://stackoverflow.com/questions/26242919/sphinx-documentation-system-multiple-substitutions-with-rst-prolog
# http://www.sphinx-doc.org/en/stable/config.html#confval-rst_prolog
#
# This will be included at the beginning of every source file that is read.
#
# Note: We intentionally include a few substitution definitions directly
# so that the placeholders used here can be replaced by Python's
# string format method.
rst_prolog = """

.. |DOC_BUILD| replace:: ``{doc_build}``
.. |DOC_COMMIT| replace:: ``{doc_commit}``
.. |DOC_BRANCH| replace:: ``{doc_branch}``

.. include:: /includes/substitution_definitions.inc.rst

"""

# http://www.sphinx-doc.org/en/stable/config.html#confval-rst_epilog
# This will be included at the end of every source file that is read.
rst_epilog = """

.. include:: /includes/footer.inc.rst

"""


###############################################################################
# Placeholder/template values to be filled in by the release_build.sh script
#
# These values are filled in as part of preparing the official docs
# distribution tarball. If the placeholder values are left intact then
# real values will be generated dynamically from info in the repo. If the
# user builds the docs from "bare" sources not yet processed
###############################################################################
# BOTH release AND version are needed for manual release builds.
version = '8.2608'  # IMPORTANT: keep in sync with scheduled stable; build docs before commit.
# release = '8.2608.0'
release = version + ' daily stable'

# Allow override from environment (e.g. Docker/CI builds without .git)
_env_version = os.environ.get('RSYSLOG_DOC_VERSION')
_env_release_type = os.environ.get('RSYSLOG_DOC_RELEASE_TYPE')


def _has_sphinx_config_override(*names):
    """Return True if Sphinx CLI overrides any named config value.

    Sphinx applies ``-D``/``--define`` overrides after executing this file, so
    inspect argv before enabling Git-derived development build metadata.
    """

    override_names = set(names)
    use_next_arg = False

    for arg in sys.argv[1:]:
        if use_next_arg:
            setting = arg
            use_next_arg = False
        elif arg in ('-D', '--define'):
            use_next_arg = True
            continue
        elif arg.startswith('-D') and len(arg) > 2:
            setting = arg[2:]
        elif arg.startswith('--define='):
            setting = arg.split('=', 1)[1]
        else:
            continue

        key = setting.split('=', 1)[0].strip()
        if key in override_names:
            return True

    return False


def _get_sphinx_config_override(name):
    """Return the final Sphinx CLI config override value for name, if present."""

    override_value = None
    use_next_arg = False

    for arg in sys.argv[1:]:
        if use_next_arg:
            setting = arg
            use_next_arg = False
        elif arg in ('-D', '--define'):
            use_next_arg = True
            continue
        elif arg.startswith('-D') and len(arg) > 2:
            setting = arg[2:]
        elif arg.startswith('--define='):
            setting = arg.split('=', 1)[1]
        else:
            continue

        key, sep, value = setting.partition('=')
        if sep and key.strip() == name:
            override_value = value

    return override_value


_cli_overrides_doc_version = _has_sphinx_config_override('version', 'release')
_cli_version = _get_sphinx_config_override('version')
_cli_release = _get_sphinx_config_override('release')
if _cli_version:
    version = _cli_version
if _cli_release:
    release = _cli_release

_rst_prolog_formatted = False
if _env_version and _env_release_type:
    version = _env_version
    release_type = _env_release_type
    release = f"{version} daily {release_type}"
    if release_type == 'dev':
        release_string_detail = 'simple'
    rst_prolog = rst_prolog.format(
        doc_build=release,
        doc_commit='N/A',
        doc_branch='N/A')
    _rst_prolog_formatted = True
# For this to be true, it means that we are not attempting to build from
# a release tarball, as otherwise the values above would have been replaced
# with official stable release values.
elif version.split('.')[0] == '8':
    release_type = 'stable'

    # Confirm that a .git folder is available. If not, skip all
    # following steps intended to generate daily stable build values for
    # 'version' and 'release' build configuration variables. In that
    # case, keep the placeholder values already set.

    # If building from a Git repo, then this entry should be present at
    # the repository root.
    git_dir = os.path.abspath(os.path.join(
        os.path.dirname(__file__), os.pardir, os.pardir, '.git'))

    if os.path.exists(git_dir) and not _cli_overrides_doc_version:

        # If the 'version' and 'release' variables are not overridden by the
        # Sphinx command line, treat this as a Git development docs build and
        # pull info from the repo to dynamically fill in build metadata.
        release_type = 'dev'

        # Valid options are "simple" and "detailed". "Simple" contains a short
        # dev build string intended for space constrained display. "Detailed"
        # contains a much longer dev build string intended for output that is
        # used for for copyediting/proofreading, where the generated docs may
        # hang around a while before being disposed of. In that situation,
        # having detailed build details in the doc are useful to help
        # differentiate multiple document builds (even from different branches)
        # from each other.
        # release_string_detail = 'detailed'
        release_string_detail = 'simple'

        # Some items in the source are wrapped with the ".. only:: TAG_NAME_HERE"
        # Sphinx directive. This directive prevents the wrapped block of markup
        # from being processed unless the specified tag is set. Using this approach
        # helps to specific content from being included in stable release docs
        # that is only intended for dev/review copies of the documentation.
        tags.add(release_type)

        # The version info for the project you're documenting, acts as replacement for
        # |version| and |release|, also used in various other places throughout the
        # built documents.
        #
        # The short X.Y version.
        version = conf_helpers.get_next_stable_version()

        # This is displayed in multiple prominent locations in the docs
        # where it is useful to be able to tell at a glance when the files
        # were generated and from what commit.
        #
        # The full version, including alpha/beta/rc tags.
        release = conf_helpers.get_release_string(
            release_type,
            release_string_detail,
            version)

        # Additions that are used by dev builds
        rst_prolog = rst_prolog.format(
            doc_build=release,
            doc_commit=conf_helpers.get_current_commit_hash(),
            doc_branch=conf_helpers.get_current_branch()
        )
        _rst_prolog_formatted = True

# Disable use of dev build logic, fall back to standard release string values.
else:
    release_type = 'stable'

if not _rst_prolog_formatted:
    rst_prolog = rst_prolog.format(
        doc_build=release,
        doc_commit='N/A',
        doc_branch='N/A')


# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
#
# Note: We list the *.inc.rst filename pattern here so that matching
# files will not be parsed as separate files to include directly into
# the documentation structure in addition to them being pulled in via
# include statements. Even with include files having been moved to the
# 'source/includes' directory the wildcard pattern has been kept to
# help rule out any issues should an include file be purposely moved
# to the root of the 'source' directory (seen a '/' by Sphinx).
exclude_patterns = ['*.inc.rst', 'includes']


# The reST default role (used for this markup: `text`) to use for all documents.
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False

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

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []

# Warn about all references where the target cannot be found. Default is False.
nitpicky = True

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

# If this is True, todo emits a warning for each TODO entries. The default
# is False.
todo_emit_warnings = True

# Suppress "unknown mimetype for ..." warnings
suppress_warnings = ['epub.unknown_project_files']

# -- Options for HTML output ---------------------------------------------------


def has_optional_extension(name):
    try:
        importlib.import_module(name)
    except ImportError:
        return False
    return True


# The base URL which points to the root of the HTML documentation.
# It is used to indicate the location of document like canonical_url and sitemap.
# DOC_BASE_URL env (e.g. https://docs.rsyslog.com) overrides when set (CI deploy).
RSYSLOG_BASE_URL = 'https://docs.rsyslog.com'
_doc_base = os.environ.get('DOC_BASE_URL', '').rstrip('/')
html_baseurl = f'{_doc_base}/doc/' if _doc_base else f'{RSYSLOG_BASE_URL}/doc/'

DISABLE_JSON_LD = os.environ.get('DISABLE_JSON_LD', '').lower() in ('1', 'true', 'yes')
ENABLE_JSON_LD = not DISABLE_JSON_LD

# Enable sitemap generation only when explicitly requested
if tags.has('with_sitemap'):
    if not has_optional_extension('sphinx_sitemap'):
        # Optional extension - sitemap generation skipped if not installed
        pass
    else:
        extensions.append('sphinx_sitemap')

        # Sitemap configuration to remove language/version from URLs
        globals().update({
            'sitemap_url_scheme': "{link}",
            'sitemap_localtolinks': False,
            'sitemap_filename': "sitemap.xml",
        })

# Enable Google Analytics tracking when a tracking ID is provided via
# the GOOGLE_ANALYTICS_ID environment variable.
_ga_id = os.environ.get('GOOGLE_ANALYTICS_ID', '')
if _ga_id and not re.match(r'^(UA-\d+-\d+|G-[A-Za-z0-9]+)$', _ga_id):
    print("Warning: Invalid GOOGLE_ANALYTICS_ID format: '%s'. "
          "Disabling GA." % _ga_id, file=sys.stderr)
    _ga_id = ''
_ga_use_extension = False
if _ga_id:
    if not has_optional_extension('sphinxcontrib.googleanalytics'):
        # Extension not installed – fall back to metatags injection in setup().
        pass
    else:
        extensions.append('sphinxcontrib.googleanalytics')
        globals().update({
            'googleanalytics_id': _ga_id,
            'googleanalytics_enabled': True,
        })
        _ga_use_extension = True

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'furo'
# html_theme = 'default'
# html_theme = 'basic'
# html_style = 'rsyslog.css'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
if release_type == 'dev':

    globals()['html_title'] = "{} {} docs".format(
        project,
        conf_helpers.get_release_string(
            release_type, release_string_detail, version)
    )

# A shorter title for the navigation bar.  Default is the same as html_title.
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None

# 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']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}

# If false, no module index is generated.
# html_domain_indices = True

# If false, no index is generated.
# html_use_index = True

# If true, the index is split into individual pages for each letter.
# html_split_index = False

# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = False

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'rsyslogdoc'


# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    # 'preamble': '',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
    ('index', 'RsyslogDoc.tex', u'Rsyslog Doc Documentation',
     u'foo bar', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False

# If true, show page references after internal links.
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
# latex_appendices = []

# If false, no module index is generated.
# latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('queues', 'rsyslog-queues', u'Rsyslog Documentation: Queues',
     [u'Rainer Gerhards'], 1),
    ('configuration/actions', 'rsyslog-actions', u'Rsyslog Documentation: Actions',
     [u'Rainer Gerhards'], 1),
]

# If true, show URL addresses after external links.
# man_show_urls = False


# -- Options for Texinfo output ------------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    ('index', 'RsyslogDoc', u'Rsyslog Doc Documentation',
     u'foo bar', 'RsyslogDoc', 'One line description of project.',
     'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
# texinfo_appendices = []

# If false, no module index is generated.
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'


# -- Options for epub output ---------------------------------------------------

# Use detailed build strings for epub format IF this is a dev build
# and NOT a stable build (which does not use detailed release strings)
if release_type == 'dev':

    # Override "simple" dev build string for epub format
    release_string_detail = 'detailed'

    globals()['epub_title'] = "{} {} docs".format(
        project,
        conf_helpers.get_release_string(
            release_type,
            release_string_detail, version
        )
    )

epub_theme = 'epub'
epub_basename = project
epub_author = author
epub_contributor = u'Rsyslog Community'
epub_publisher = 'http://www.rsyslog.com/'
epub_description = u'Documentation for the rsyslog project'


# http://www.sphinx-doc.org/en/stable/extdev/appapi.html#sphinx.application.Sphinx.add_stylesheet
# Include our custom stylesheet in addition to specified theme
def setup(app):
    app.add_css_file('rsyslog.css')

    if ENABLE_JSON_LD:
        app.connect('html-page-context', _add_json_ld_to_context)

    # Google Analytics: inject gtag script via metatags when the
    # sphinxcontrib.googleanalytics extension is not handling it.
    if _ga_id and not _ga_use_extension:
        def _inject_ga(app, pagename, templatename, context, doctree):
            if app.builder.format == 'html':
                m = context.get('metatags', '')
                m += (
                    '\n<script async src="https://www.googletagmanager.com/'
                    'gtag/js?id=%s"></script>\n'
                    '<script>\n'
                    'window.dataLayer = window.dataLayer || [];\n'
                    'function gtag(){dataLayer.push(arguments);}\n'
                    'gtag("js", new Date());\n'
                    'gtag("config", "%s");\n'
                    '</script>\n'
                ) % (_ga_id, _ga_id)
                context['metatags'] = m
        app.connect('html-page-context', _inject_ga)


def _add_json_ld_to_context(app, pagename, templatename, context, doctree):
    if app.builder.format != 'html':
        return

    canonical_url = urljoin(html_baseurl, f"{pagename}.html")

    meta = context.get('meta')

    author_name = None
    if isinstance(meta, dict):
        author_name = meta.get('author') or meta.get('authors')
        if isinstance(author_name, list):
            author_name = author_name[0] if author_name else None

    if not author_name:
        author_name = context.get('author') or author

    faq_entries = _extract_faq_entries(doctree) if pagename.startswith('faq/') else []

    json_ld = {
        "@context": "https://schema.org",
        "@type": "FAQPage" if faq_entries else "TechArticle",
        "headline": context.get('title', pagename),
        "author": author_name,
        "url": canonical_url,
        "inLanguage": context.get('language', app.config.language) or 'en',
    }

    if faq_entries:
        json_ld['mainEntity'] = faq_entries

    description = None
    if isinstance(meta, dict):
        description = meta.get('description')
        if isinstance(description, list) and description:
            description = description[0]

    if description:
        json_ld['description'] = description

    metatags = context.get('metatags', '')
    json_ld_string = json.dumps(json_ld, indent=2)
    script_tag = f'\n<script type="application/ld+json">\n{json_ld_string}\n</script>\n'
    context['metatags'] = metatags + script_tag


def _extract_faq_entries(doctree):
    faq_entries = []

    if doctree is None:
        return faq_entries

    for section in doctree.traverse(nodes.section):
        title_node = section.next_node(nodes.title)
        if title_node is None:
            continue

        question = title_node.astext().strip()
        if not question:
            continue

        answers = []
        for child in section.children:
            if isinstance(child, nodes.title):
                continue

            text = child.astext().strip()
            if text:
                answers.append(text)

        if not answers:
            continue

        faq_entries.append(
            {
                "@type": "Question",
                "name": question,
                "acceptedAnswer": {
                    "@type": "Answer",
                    "text": "\n\n".join(answers),
                },
            }
        )

    return faq_entries

# -- Conditional settings for minimal singlehtml build ----------------------------
# This block is activated by the '-t minimal_build' tag passed from the Makefile
# for the 'singlehtml' target. It strips the output for AI ingestion.


if tags.has('minimal_build'):
    # Point to a directory with empty templates to remove entire theme sections
    # The files inside _templates_minimal are intentionally blank.
    templates_path = ['_templates_minimal']

    globals().update({
        # Disable all sidebars
        'html_sidebars': {'**': []},
        # Turn off other non-content elements
        'html_show_sourcelink': False,
        'html_show_sphinx': False,
        'html_show_copyright': False,
    })