Skip to content

Update sphinx to 9.x #2942

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
JordonPhillips merged 3 commits into from
Jan 26, 2026
Merged

Update sphinx to 9.x #2942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fa4ef08
Update sphinx to 9.x
JordonPhillips Jan 22, 2026
bb86e64
Update 1.0 docs to use new tab library
JordonPhillips Jan 23, 2026
923ce73
Add changelog entry for tabs update
JordonPhillips Jan 23, 2026
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
7 changes: 7 additions & 0 deletions .changes/next-release/documentation-c3032bfab7d72e585876ebdf5918879eaa7006bb.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "documentation",
"description": "Updated Sphinx to 9.1 and updated the tabs in the Smithy 1.0 docs to use the same tab library that 2.0 uses.",
"pull_requests": [
"[#2942](https://github.com/smithy-lang/smithy/pull/2942)"
]
}
37 changes: 26 additions & 11 deletions docs/landing-page/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 1 addition & 4 deletions docs/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,14 @@ module-root = ""
name = "smithy"
version = "1.0.0"
dependencies = [
"sphinx==8.2.3",
"sphinx==9.1.0",
"pygments==2.19.2",
"furo==2025.12.19",

# Used by new docs
"sphinx-inline-tabs==2025.12.21.14",
"Sphinx-Substitution-Extensions==2026.1.12",

# Used by old docs
"sphinx-tabs>=3.4.7",

"sphinx_copybutton==0.5.2",
"sphinx-autobuild==2025.8.25",

Expand Down
4 changes: 2 additions & 2 deletions docs/source-1.0/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
with open(shared_config) as file:
exec(file.read())

# TODO: Migrate to use the 2.0 tabs library.
extensions.append("sphinx_tabs.tabs")
# Add sphinx-inline-tabs extension for converted tabs
extensions.append("sphinx_inline_tabs")

# Place version specific overrides after here.
html_title = "Smithy 1.0"
Expand Down
Loading
Loading