Repository navigation
Fix Sphinx Documentation - #33
Merged
Merged
Conversation
ojii
approved these changes
Jan 27, 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.
Resolves #24
The cryptography
Certificatesreference in the documentation currently displays the rust bindings. This means that Sphinx is unable to useintersphinx_mappingto link them. By importing it and overwriting__module__, docs generation works as expected.Seems like the default values for
ValidationConfigare causing problems and making the docs "restate" the attributes here. Including a docstring lets us overwrite the displayed text with something cleaner, reserving the more descriptive but more complex types for the attributes below.