30fb3cbb4f
* fix(docs): Fix links and versions * fix(docs): Apply suggestions and leftover substitutions
62 lines
1.4 KiB
Python
62 lines
1.4 KiB
Python
# ---------------------------------------------------------------
|
|
|
|
from esp_docs.conf_docs import * # noqa: F403,F401
|
|
|
|
# Used for substituting variables in the documentation
|
|
rst_prolog = """
|
|
.. |version| replace:: 3.2.0
|
|
.. |idf_version| replace:: 5.4
|
|
"""
|
|
|
|
languages = ["en"]
|
|
|
|
# idf_targets = [
|
|
# "esp32",
|
|
# "esp32s2",
|
|
# "esp32s3",
|
|
# "esp32c3",
|
|
# "esp32c6",
|
|
# "esp32h2",
|
|
# ]
|
|
|
|
# link roles config
|
|
github_repo = "espressif/arduino-esp32"
|
|
|
|
# context used by sphinx_idf_theme
|
|
html_context["github_user"] = "espressif" # noqa: F405
|
|
html_context["github_repo"] = "arduino-esp32" # noqa: F405
|
|
|
|
html_static_path = ["../_static"]
|
|
|
|
# Conditional content
|
|
|
|
extensions += [ # noqa: F405
|
|
"sphinx_copybutton",
|
|
"sphinx_tabs.tabs",
|
|
"sphinx_substitution_extensions", # For allowing substitutions inside code blocks
|
|
"esp_docs.esp_extensions.dummy_build_system",
|
|
]
|
|
|
|
# ESP32_DOCS = [
|
|
# "index.rst",
|
|
# ]
|
|
|
|
# ESP32S2_DOCS = ESP32_DOCS
|
|
# ESP32C3_DOCS = ESP32S2_DOCS
|
|
# ESP32S3_DOCS = ESP32S2_DOCS
|
|
# ESP32C6_DOCS = ESP32S2_DOCS
|
|
# ESP32H2_DOCS = ESP32S2_DOCS
|
|
|
|
# conditional_include_dict = {
|
|
# "esp32": ESP32_DOCS,
|
|
# "esp32s2": ESP32S2_DOCS,
|
|
# "esp32c3": ESP32C3_DOCS,
|
|
# "esp32s3": ESP32S3_DOCS,
|
|
# "esp32c6": ESP32C6_DOCS,
|
|
# "esp32h2": ESP32H2_DOCS,
|
|
# }
|
|
|
|
# Extra options required by sphinx_idf_theme
|
|
project_slug = "arduino-esp32"
|
|
|
|
# versions_url = "./../_static/arduino_versions.js"
|