This is an automated email from the ASF dual-hosted git repository.
shahar1 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 294467ab1f9 Exclude auto-generated REST API reference from docs
spell-check (#68114)
294467ab1f9 is described below
commit 294467ab1f926175675f31aa7ee4315748f36ab0
Author: Jarek Potiuk <[email protected]>
AuthorDate: Sat Jun 6 06:00:02 2026 +0200
Exclude auto-generated REST API reference from docs spell-check (#68114)
The ``stable-rest-api-ref`` page renders the OpenAPI spec via the
``swagger-plugin`` directive. Spell-checking the rendered output flags
machine-generated tokens (camelCase URL path segments, operationIds,
JSON-Schema keywords such as ``oneOf``) as misspellings, which breaks the
docs build whenever new endpoints are added.
Exclude it from spell-check, the same way the other generated pages
(``project.rst``, ``changelog.rst``) already are.
---
airflow-core/docs/conf.py | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/airflow-core/docs/conf.py b/airflow-core/docs/conf.py
index d8e0d76ef53..690721a4df3 100644
--- a/airflow-core/docs/conf.py
+++ b/airflow-core/docs/conf.py
@@ -350,7 +350,11 @@ redirects_file = "redirects.txt"
# -- Options for sphinxcontrib-spelling
----------------------------------------
spelling_word_list_filename = [SPELLING_WORDLIST_PATH.as_posix()]
-spelling_exclude_patterns = ["project.rst", "changelog.rst"]
+# ``stable-rest-api-ref.rst`` renders the OpenAPI spec via the
``swagger-plugin``
+# directive. Its content is machine-generated (camelCase URL path segments,
+# operationIds, JSON-Schema keywords such as ``oneOf``), not prose, so
spell-checking
+# it only produces false positives that re-break the build on every new
endpoint.
+spelling_exclude_patterns = ["project.rst", "changelog.rst",
"stable-rest-api-ref.rst"]
spelling_ignore_contributor_names = False
spelling_ignore_importable_modules = True
