Repository navigation
Integrate GitHub README as Sphinx landing page with custom extension - #64
Merged
Merged
Conversation
## Changes: - Added a custom Sphinx extension `github_readme` to parse GitHub README syntax into MyST format. - Updated documentation to use GitHub-flavored Markdown features (`colon_fence`, `linkify`, `tasklist`, etc.). - Modified `README.md` to incorporate GitHub alert syntax. - Added unit tests for README parsing and custom extension validation. - Updated `pyproject.toml` to include `linkify-it-py` dependency.
…down compatibility
JeanMainguy
approved these changes
Oct 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
GitHub format and Sphinx format are not fully compatible. As the README is used in both the GitHub main page and the documentation first page, one or the other was badly formatted. In this PR I intend to fix it without duplicating file by writing a custom script called in the documentation building.
What changed
github_readmeto parse GitHub README syntax into MyST format.colon_fence,linkify,tasklist, etc.).README.mdto incorporate GitHub alert syntax.pyproject.tomlto includelinkify-it-pydependency.Testing
A new unitary script works as a first cheap barrier. It's fast and doesn't need Sphinx or the test dataset. If someone adds MyST syntax to the README, CI fails and shows the line, before it reaches GitHub.
Rendering was tested both locally and directly into ReadTheDocs.
Documentation
Checklist
devbranch