diff --git a/.gitlab/ci/docs.yml b/.gitlab/ci/docs.yml index 222cdf2083..783c6bade9 100644 --- a/.gitlab/ci/docs.yml +++ b/.gitlab/ci/docs.yml @@ -228,5 +228,4 @@ check_doc_links: - pip install -r requirements.txt - cd docs - pip install -U -r requirements.txt - # At the moment this check will always fail due to multiple known limitations, ignore result - - build-docs -t $DOCTGT -l $DOCLANG linkcheck || { echo "THERE ARE ISSUES DUE TO KNOWN LIMITATIONS, PLEASE FIX THEM. Nowadays we're ignored them to pass pipeline."; true; } + - build-docs -t $DOCTGT -l $DOCLANG linkcheck diff --git a/docs/conf_common.py b/docs/conf_common.py index c8db151621..1942555e06 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -172,6 +172,19 @@ google_analytics_id = os.environ.get('CI_GOOGLE_ANALYTICS_ID', None) project_homepage = 'https://github.com/espressif/esp-idf' +linkcheck_anchors = False + +linkcheck_exclude_documents = ['index', # several false positives due to the way we link to different sections + 'api-reference/protocols/esp_local_ctrl', # Fails due to `https://.local` + 'api-reference/provisioning/wifi_provisioning', # Fails due to `https://.local` + ] + + +linkcheck_ignore = ['https://webhome.phy.duke.edu/~rgb/General/dieharder.php', # Certificate error + 'https://dl.espressif.com/dl/esp32s3_rom.elf', # Not published + ] + + # Custom added feature to allow redirecting old URLs with open('../page_redirects.txt') as f: lines = [re.sub(' +', ' ', line.strip()) for line in f.readlines() if line.strip() != '' and not line.startswith('#')]