Replace m2r2 with sphinx-mdinclude #194
Merged
Conversation
This file contains 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
MarJMue
force-pushed
the
sphinx-mdinclude
branch
from
bdd3e92 to
98455ff
Compare
domna
approved these changes
Oct 8, 2024
There was a problem hiding this comment.
Thanks for investigating this.
Maybe we should think about our rtd integration in the future. We have a CI build for PRs but it did not actually fail on this. Ideally, we would have an action which does a rtd test deploy so that we directly see if anything is failing before we do releases.
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.
Fix for the current error during documentation generation:
sphinx-mdinclude is a newer fork of m2r2 and more actively developed.
Should work as drop-in replacement.