mirror of
https://github.com/espressif/esp-mqtt.git
synced 2025-10-05 19:41:39 +02:00
ci: Adds documentation build
- Adds documentation build and deploy - Removes QEMU test as it is outdated
This commit is contained in:
39
docs/conf_common.py
Normal file
39
docs/conf_common.py
Normal file
@@ -0,0 +1,39 @@
|
||||
# -*- 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
|
||||
|
||||
# IDF_PATH validation removed - not needed for standalone component docs
|
||||
# Only required when using ESP-IDF extensions that depend on IDF environment
|
||||
|
||||
|
||||
extensions += ['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-mqtt'
|
||||
|
||||
# context used by sphinx_idf_theme
|
||||
html_context['github_user'] = 'espressif'
|
||||
html_context['github_repo'] = 'esp-mqtt'
|
||||
|
||||
# Extra options required by sphinx_idf_theme
|
||||
project_slug = 'esp-mqtt'
|
||||
versions_url = './_static/mqtt_docs_versions.js'
|
||||
|
||||
idf_targets = [ 'esp32' ]
|
||||
languages = ['en']
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user