Files
esp-modbus/docs/conf_common.py

37 lines
1.0 KiB
Python

# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: Apache-2.0
# -*- coding: utf-8 -*-
#
# Common (non-language-specific) configuration for Sphinx
#
# type: ignore
# pylint: disable=wildcard-import
# pylint: disable=undefined-variable
from __future__ import print_function, unicode_literals
from esp_docs.conf_docs import * # noqa: F403,F401,F405
extensions += [ # noqa: F403,F401,F405
"sphinx_copybutton",
# 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-modbus"
# context used by sphinx_idf_theme
html_context["github_user"] = "espressif" # noqa: F403,F401,F405
html_context["github_repo"] = "esp-modbus" # noqa: F403,F401,F405
html_static_path = ["../_static"]
# Extra options required by sphinx_idf_theme
project_slug = "esp-modbus"
versions_url = "./_static/modbus_docs_versions.js"
idf_targets = ["esp32"]
languages = ["en"]