docs: build and publish PDF documents

This commit is contained in:
Wang Fang
2025-07-08 15:25:26 +08:00
parent c7dd22d832
commit a04c54b84e
3 changed files with 10 additions and 3 deletions
+2 -1
View File
@@ -644,11 +644,12 @@ build_docs:
paths:
- docs/_build/*/*/*.txt
- docs/_build/*/*/html/*
- docs/_build/*/*/latex/*
expire_in: 1 days
script:
- cd docs
- pip install -r requirements.txt
- build-docs -t esp32 esp32s3 esp32c2 esp32c3 esp32c6 esp32h2 esp32p4 esp32c5 -l en
- build-docs -bs html latex -t esp32 esp32s3 esp32c2 esp32c3 esp32c6 esp32h2 esp32p4 esp32c5 -l en
# disable link checks for now, as it is failing due to some links taking longer time to respond
# - build-docs -t esp32 -l en linkcheck
+7 -1
View File
@@ -60,4 +60,10 @@ project_slug = 'esp-matter'
versions_url = '_static/esp_sdk_matter_version.js'
# Final PDF filename will contains target and version
pdf_file_prefix = u'esp-docs'
pdf_file_prefix = u'esp-matter'
# Disable index in LaTeX output, as it's not rendered correctly
latex_elements = {
'printindex': '',
'makeindex': '',
}
+1 -1
View File
@@ -20,7 +20,7 @@ except ImportError:
# General information about the project.
project = u'Espressif\'s SDK for Matter'
copyright = u'2022 - {}, Espressif Systems (Shanghai) Co., Ltd'.format(datetime.datetime.now().year)
pdf_title = u'Example Guide'
pdf_title = u'ESP-Matter Programming Guide'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.