Skip to content

Render GH Markdown alerts in Sphinx docs #4663

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
abdnh merged 4 commits into from
Apr 8, 2026
Merged

Render GH Markdown alerts in Sphinx docs #4663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
92d2b95
Add the sphinx_github_alerts extension
abdnh Apr 3, 2026
1867f42
Remove my email from CONTRIBUTORS
abdnh Apr 3, 2026
15f0ea3
Use click-extra instead
abdnh Apr 3, 2026
696a211
Merge branch 'main' into gh-md-alerts
abdnh Apr 7, 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
2 changes: 1 addition & 1 deletion CONTRIBUTORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ neitrinoweb <github.com/neitrinoweb/>
Andreas Reis <github.com/nwwt>
Matt Krump <github.com/mkrump>
Alexander Presnyakov <flagist0@gmail.com>
Abdo <abdo@abdnh.net>
Abdo <github.com/abdnh>
aplaice <plaice.adam+github@gmail.com>
phwoo <github.com/phwoo>
Soren Bjornstad <anki@sorenbjornstad.com>
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"myst_parser",
"sphinx.ext.intersphinx",
"autoapi.extension",
"click_extra.sphinx",
]

source_suffix = {
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "anki-dev"
version = "0.0.0"
description = "Local-only environment"
requires-python = ">=3.9"
requires-python = ">=3.12"
Copy link
Copy Markdown
Collaborator Author

@abdnh abdnh Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be OK for the local environment.

classifiers = ["Private :: Do Not Upload"]

[dependency-groups]
Expand Down Expand Up @@ -32,6 +32,7 @@ docs = [
"sphinx-book-theme",
"sphinx-autoapi",
"sphinx-autobuild>=2024.10.3",
"click-extra[sphinx]", # for GitHub alerts
]

[tool.uv.workspace]
Expand Down
Loading
Loading