Skip to content

Commit

Permalink
feat(docs): Replace PDF download link with HTML zip download link
Browse files Browse the repository at this point in the history
PDF build would randomly fail after S3 docs grew to a certain size.

At 3k+ pages PDF is not very usable anyways.
For offline use an HTML archive makes more sense.
ESP-Marius committed Dec 19, 2024
1 parent fa41faf commit 0140c6f
Showing 4 changed files with 7 additions and 18 deletions.
16 changes: 0 additions & 16 deletions .gitlab/ci/docs.yml
Original file line number Diff line number Diff line change
@@ -139,19 +139,6 @@ build_docs_html_partial:
- DOCLANG: "zh_CN"
DOCTGT: "esp32p4"

build_docs_pdf:
extends:
- .build_docs_template
- .doc-rules:build:docs-full
artifacts:
when: always
paths:
- docs/_build/*/*/latex/*
expire_in: 4 days
allow_failure: true # TODO IDFCI-2216
variables:
DOC_BUILDERS: "latex"

.deploy_docs_template:
image: $ESP_IDF_DOC_ENV_IMAGE
variables:
@@ -180,8 +167,6 @@ deploy_docs_preview:
optional: true
- job: build_docs_html_full
optional: true
- job: build_docs_pdf
optional: true
variables:
TYPE: "preview"
# older branches use DOCS_DEPLOY_KEY, DOCS_SERVER, DOCS_SERVER_USER, DOCS_PATH for preview server so we keep these names for 'preview'
@@ -202,7 +187,6 @@ deploy_docs_production:
dependencies: # set dependencies to null to avoid missing artifacts issue
needs: # ensure runs after push_to_github succeeded
- build_docs_html_full
- build_docs_pdf
- job: push_to_github
artifacts: false
variables:
1 change: 1 addition & 0 deletions docs/conf_common.py
Original file line number Diff line number Diff line change
@@ -331,6 +331,7 @@
'esp_docs.idf_extensions.kconfig_reference',
'esp_docs.idf_extensions.gen_idf_tools_links',
'esp_docs.esp_extensions.run_doxygen',
'esp_docs.esp_extensions.add_html_zip',
'linuxdoc.rstFlatTable', # https://return42.github.io/linuxdoc/linuxdoc-howto/table-markup.html#flat-table
]

4 changes: 3 additions & 1 deletion docs/en/conf.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# type: ignore
# -*- coding: utf-8 -*-
#
# English Language RTD & Sphinx config file
#
# Uses ../conf_common.py for most non-language-specific settings.

# Importing conf_common adds all the non-language-specific
# parts to this conf module
try:
@@ -25,3 +25,5 @@
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = 'en'

html_zip = f'esp-idf-{language}-{release}' # noqa: F405
4 changes: 3 additions & 1 deletion docs/zh_CN/conf.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# type: ignore
# -*- coding: utf-8 -*-
#
# English Language RTD & Sphinx config file
#
# Uses ../conf_common.py for most non-language-specific settings.

# Importing conf_common adds all the non-language-specific
# parts to this conf module
try:
@@ -25,3 +25,5 @@
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = 'zh_CN'

html_zip = f'esp-idf-{language}-{release}' # noqa: F405

0 comments on commit 0140c6f

Please sign in to comment.