conf_common.py

# -*- coding: utf-8 -*-
#
# Common (non-language-specific) configuration for Sphinx
#
# This file is imported from a language-specific conf.py (ie en/conf.py or
# zh_CN/conf.py)

#ESP_DOCS_PATH = os.environ['ESP_DOCS_PATH']

import os
import re

from esp_docs.conf_docs import *  # noqa: F403,F401

# format: {tag needed to include: documents to included}, tags are parsed from sdkconfig and peripheral_caps.h headers

extensions += [ 'sphinx_copybutton',
                'sphinxcontrib.wavedrom',
                'esp_docs.esp_extensions.dummy_build_system',
                'esp_docs.esp_extensions.run_doxygen',
                ]
# link roles config
github_repo = 'espressif/esp-iot-solution'

# context used by sphinx_idf_theme
html_context['github_user'] = 'espressif'
html_context['github_repo'] = 'esp-iot-solution'


def _branch_to_doc_release(branch):
    """Map a git branch name to the doc release key used in feedback doc_id_mapping."""
    latest_branch_name = os.environ.get('ESP_DOCS_LATEST_BRANCH_NAME', 'master')
    if branch == latest_branch_name:
        return 'latest'
    return re.sub(r'[^a-zA-Z0-9._-]', '-', branch)


# In MR preview builds, CI_COMMIT_REF_NAME is the source branch; use the MR target
# branch so feedback docId matches the document line the MR will merge into.
_mr_target_branch = os.environ.get('CI_MERGE_REQUEST_TARGET_BRANCH_NAME')
html_context['feedback_doc_release'] = (
    _branch_to_doc_release(_mr_target_branch) if _mr_target_branch else None
)

languages = ['en', 'zh_CN']

project_homepage = 'https://github.com/espressif/esp-iot-solution'

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '../_static/espressif-logo.svg'

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

versions_url = './_static/js/generic_version.js'

# Extra options required by sphinx_idf_theme
project_slug = 'esp-iot-solution'

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

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build','README.md']

# Final PDF filename will contains target and version
pdf_file_prefix = u'esp-iot-solution'

# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = '../_static/espressif2.pdf'

# add Tracking ID for Google Analytics
google_analytics_id = 'G-YK0H573CWX'