Skip to content

Render GH Markdown alerts in Sphinx docs#4663

Merged
abdnh merged 4 commits intomainfrom
gh-md-alerts
Apr 8, 2026
Merged

Render GH Markdown alerts in Sphinx docs#4663
abdnh merged 4 commits intomainfrom
gh-md-alerts

Conversation

@abdnh
Copy link
Copy Markdown
Collaborator

@abdnh abdnh commented Apr 3, 2026

@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community bot commented Apr 3, 2026

Documentation build overview

📚 Anki | 🛠️ Build #32150901 | 📁 Comparing 696a211 against latest (c767930)

  🔍 Preview build  

Show files changed (1 files in total): 📝 1 modified | ➕ 0 added | ➖ 0 deleted
File Status
windows.html 📝 modified

@abdnh
Copy link
Copy Markdown
Collaborator Author

abdnh commented Apr 3, 2026

The sphinx-github-alerts extension doesn't handle nesting properly.
image

Comment thread pyproject.toml
version = "0.0.0"
description = "Local-only environment"
requires-python = ">=3.9"
requires-python = ">=3.12"
Copy link
Copy Markdown
Collaborator Author

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.

@abdnh
Copy link
Copy Markdown
Collaborator Author

abdnh commented Apr 3, 2026

Rendering properly now using the click_extra.sphinx extension.

@abdnh abdnh requested a review from andrewsanchez April 3, 2026 13:22
@abdnh abdnh merged commit 81eefc5 into main Apr 8, 2026
6 checks passed
@abdnh abdnh deleted the gh-md-alerts branch April 8, 2026 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants