Build documentation with mkdocstrings fix #13
Closed
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
Co-authored-by: william <[email protected]>
…s runtime - Add mkdocstrings-python and pin griffe to restore griffe.collections API - Pin setuptools<81 to satisfy mike/pkg_resources deprecation window - Update mkdocs.yml to allow inspection and preload extension module - Tweak python/rsmime/__init__.py to set __module__ and map exceptions - Add rsmime.pyi stub so mkdocstrings can resolve extension symbols
|
Cursor Agent can help with this pull request. Just |
tiwilliam
deleted the
cursor/build-documentation-with-mkdocstrings-fix-db10
branch
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.
Pin documentation dependencies and adjust
rsmimemodule introspection to fix thegriffe.collectionsimport error during docs build.The
ModuleNotFoundError: No module named 'griffe.collections'occurred becausemkdocstringsandgriffeversions were incompatible, andmkdocstringswas unable to properly introspect the compiledrsmimeextension module. This PR pins compatible versions, enablesmkdocstringsinspection, preloads thersmimemodule, and explicitly sets__module__andsys.modulesfor the extension's classes and exceptions to aid introspection.