Skip to content

[v2-10-test] Upgrade sphinx and related dependencies (#45563) #45596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
potiuk merged 2 commits into from
Jan 12, 2025
Merged

[v2-10-test] Upgrade sphinx and related dependencies (#45563) #45596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfe00d3
Upgrade sphinx and related dependencies (#45563)
shahar1 Jan 12, 2025
3cd04aa
fixup! Upgrade sphinx and related dependencies (#45563)
potiuk Jan 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/exts/airflow_intersphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ def fetch_inventories(intersphinx_mapping) -> dict[str, Any]:
cache: dict[Any, Any] = {}
with concurrent.futures.ThreadPoolExecutor() as pool:
for name, (uri, invs) in intersphinx_mapping.values():
pool.submit(fetch_inventory_group, name, uri, invs, cache, _MockApp(), now)
pool.submit(fetch_inventory_group, name, uri, invs, cache, _MockApp(), now) # type: ignore[arg-type]

inv_dict = {}
for uri, (name, now, invdata) in cache.items():
Expand Down
35 changes: 35 additions & 0 deletions docs/sphinx_design/static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,38 @@
--sd-color-tabs-underline-hover: #68d1ff;
--sd-color-tabs-underline: transparent;
}

div.admonition.warning {
background: #e8cccc;
font-weight: bolder;
}

.rst-content .warning .admonition-title {
background: #cc341d;
}

/* Patches as of moving to Sphinx 7 to get layout to previous state */
/* Needs to be cleaned in a follow-up to source this from the origin style in */
/* https://github.com/apache/airflow-site/blob/main/landing-pages/site/assets/scss/_rst-content.scss */
.base-layout {
padding-top: 123px !important;
}

section {
padding-top: 0rem !important;
padding-bottom: 0rem !important;
}

section ol li p:last-child, section ul li p:last-child {
margin-bottom: 0 !important;
}

a.headerlink {
content: "" !important;
font-size: 75% !important;
}

a.headerlink::after {
content: " [link]" !important; /* Theme image not existing */
visibility: visible !important;
}
53 changes: 22 additions & 31 deletions hatch_build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,37 +156,28 @@

DOC_EXTRAS: dict[str, list[str]] = {
"doc": [
"astroid>=2.12.3,<3.0",
"checksumdir>=1.2.0",
# click 8.1.4 and 8.1.5 generate mypy errors due to typing issue in the upstream package:
# https://github.com/pallets/click/issues/2558
"click>=8.0,!=8.1.4,!=8.1.5",
# Docutils 0.17.0 converts generated <div class="section"> into <section> and breaks our doc formatting
# By adding a lot of whitespace separation. This limit can be lifted when we update our doc to handle
# <section> tags for sections
"docutils<0.17,>=0.16",
# The new theme 0.1.0 is for Sphinx 7. Airflow 2. still uses old version of Sphinx
"sphinx-airflow-theme>=0.0.12,<0.1.0",
"sphinx-argparse>=0.4.0",
# sphinx-autoapi fails with astroid 3.0, see: https://github.com/readthedocs/sphinx-autoapi/issues/407
# This was fixed in sphinx-autoapi 3.0, however it has requirement sphinx>=6.1, but we stuck on 5.x
"sphinx-autoapi>=2.1.1",
"sphinx-copybutton>=0.5.2",
"sphinx-design>=0.5.0",
"sphinx-jinja>=2.0.2",
"sphinx-rtd-theme>=2.0.0",
# Currently we are using sphinx 5 but we need to migrate to Sphinx 7
"sphinx>=5.3.0,<6.0.0",
"sphinxcontrib-applehelp>=1.0.4",
"sphinxcontrib-devhelp>=1.0.2",
"sphinxcontrib-htmlhelp>=2.0.1",
"sphinxcontrib-httpdomain>=1.8.1",
"sphinxcontrib-jquery>=4.1",
"sphinxcontrib-jsmath>=1.0.1",
"sphinxcontrib-qthelp>=1.0.3",
"sphinxcontrib-redoc>=1.6.0",
"sphinxcontrib-serializinghtml==1.1.5",
"sphinxcontrib-spelling>=8.0.0",
"astroid>=3; python_version >= '3.9'",
"checksumdir>=1.2.0; python_version >= '3.9'",
"click>=8.1.8; python_version >= '3.9'",
"docutils>=0.21; python_version >= '3.9'",
"sphinx-airflow-theme>=0.1.0; python_version >= '3.9'",
"sphinx-argparse>=0.4.0; python_version >= '3.9'",
"sphinx-autoapi>=3; python_version >= '3.9'",
"sphinx-copybutton>=0.5.2; python_version >= '3.9'",
"sphinx-design>=0.5.0; python_version >= '3.9'",
"sphinx-jinja>=2.0.2; python_version >= '3.9'",
"sphinx-rtd-theme>=2.0.0; python_version >= '3.9'",
"sphinx>=7; python_version >= '3.9'",
"sphinxcontrib-applehelp>=1.0.4; python_version >= '3.9'",
"sphinxcontrib-devhelp>=1.0.2; python_version >= '3.9'",
"sphinxcontrib-htmlhelp>=2.0.1; python_version >= '3.9'",
"sphinxcontrib-httpdomain>=1.8.1; python_version >= '3.9'",
"sphinxcontrib-jquery>=4.1; python_version >= '3.9'",
"sphinxcontrib-jsmath>=1.0.1; python_version >= '3.9'",
"sphinxcontrib-qthelp>=1.0.3; python_version >= '3.9'",
"sphinxcontrib-redoc>=1.6.0; python_version >= '3.9'",
"sphinxcontrib-serializinghtml>=1.1.5; python_version >= '3.9'",
"sphinxcontrib-spelling>=8.0.0; python_version >= '3.9'",
],
"doc-gen": [
"apache-airflow[doc]",
Expand Down