fix(docs): drop unmaintained m2r2 to unbreak readthedocs build#105
Open
fix(docs): drop unmaintained m2r2 to unbreak readthedocs build#105
Conversation
m2r2 imports pkg_resources at module load, which is no longer shipped in newer Python/setuptools environments. Sphinx fails with "Could not import extension m2r2 (exception: No module named 'pkg_resources')" during RTD's build. m2r2 was registered as an extension and .md was in source_suffix, but no markdown files are included anywhere in the docs tree, so the dependency is dead weight. Removing m2r2 from extensions and requirements eliminates the failure with no functional loss. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
1 participant
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.
Summary
Could not import extension m2r2 (exception: No module named 'pkg_resources').m2r2importspkg_resourcesat module load, which newer setuptools/Python environments no longer ship by default.m2r2was registered as a Sphinx extension and.mdwas insource_suffix, but no markdown files are included anywhere inpy-ft/docs/(nomdinclude, no.. include:: *.md), so the extension was dead weight.m2r2fromextensionsandrequirements.txteliminates the failure with no functional loss.Reference failing build (commit
83d5eec): https://app.readthedocs.org/projects/py-ft/builds/32435915/Test plan
index.rst,api.rst, and the vignette notebooks correctly🤖 Generated with Claude Code