2025-09-25 15:49:41 +02:00
|
|
|
# SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
|
|
|
|
|
# SPDX-License-Identifier: Apache-2.0
|
2025-09-23 15:17:59 +02:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
|
#
|
|
|
|
|
# Common (non-language-specific) configuration for Sphinx
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
# type: ignore
|
|
|
|
|
# pylint: disable=wildcard-import
|
|
|
|
|
# pylint: disable=undefined-variable
|
2025-09-25 15:49:41 +02:00
|
|
|
# ruff: noqa: F405
|
2025-09-23 15:17:59 +02:00
|
|
|
|
|
|
|
|
from __future__ import print_function, unicode_literals
|
|
|
|
|
|
|
|
|
|
from esp_docs.conf_docs import * # noqa: F403,F401
|
|
|
|
|
|
|
|
|
|
# IDF_PATH validation removed - not needed for standalone component docs
|
|
|
|
|
# Only required when using ESP-IDF extensions that depend on IDF environment
|
|
|
|
|
|
|
|
|
|
|
2025-09-25 15:49:41 +02:00
|
|
|
extensions += ['sphinx_copybutton', # noqa: F405
|
2025-09-23 15:17:59 +02:00
|
|
|
# Needed as a trigger for running doxygen
|
|
|
|
|
'esp_docs.esp_extensions.dummy_build_system',
|
|
|
|
|
'esp_docs.esp_extensions.run_doxygen'
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
# link roles config
|
|
|
|
|
github_repo = 'espressif/esp-mqtt'
|
|
|
|
|
|
|
|
|
|
# context used by sphinx_idf_theme
|
2025-09-25 15:49:41 +02:00
|
|
|
html_context['github_user'] = 'espressif' # noqa: F405
|
|
|
|
|
html_context['github_repo'] = 'esp-mqtt' # noqa: F405
|
2025-09-23 15:17:59 +02:00
|
|
|
|
|
|
|
|
# Extra options required by sphinx_idf_theme
|
|
|
|
|
project_slug = 'esp-mqtt'
|
|
|
|
|
versions_url = './_static/mqtt_docs_versions.js'
|
|
|
|
|
|
|
|
|
|
idf_targets = [ 'esp32' ]
|
|
|
|
|
languages = ['en']
|
