-
Notifications
You must be signed in to change notification settings - Fork 3
Migrate from sphinx to mkdocs #238
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.
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
Open
pavelzw
wants to merge
25
commits into
main
Choose a base branch
from
mkdocs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
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
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #238 +/- ##
==========================================
+ Coverage 92.27% 92.38% +0.11%
==========================================
Files 18 21 +3
Lines 2058 2062 +4
==========================================
+ Hits 1899 1905 +6
+ Misses 159 157 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Include a link example to another module function (:meth: in sphinx). Fix some ruff complaints.
Collaborator
|
@pavelzw I took the liberty of moving this forward. Your feedback is ofc very welcome! |
ivergara
approved these changes
Jan 19, 2026
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.
Edited by @kklein
This PR migrates
datajudges documentation engine fromsphinxtomkdocs.Motivation
Changes
.rstfile to a.markdownfile.db_accessto dedicated modules and to explicitly excludedb_accessfrom the api documentation. Prior to this PR we didn't generate any documentation for it either since it is really not meant to be used by end users._suffix. Private objects are configured to not appear in the auto-generated api documentation.Comparison
before
after