Update docs builds #787
Merged
Update docs builds #787
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
Errors like the following appeared when building the docs: ``` sqlalchemy_utils/types/range.py: docstring of sqlalchemy_utils.types.range.RangeComparator.contains: 14: ERROR: Unknown interpreted text role "paramref". ``` It appears that the autodoc extension reaches into parent class implementations to find docstrings, but the sqlalchemy docstrings contain a custom text role and cause errors. This is resolved by adding docstrings to the affected functions.
josecsotomorales
approved these changes
Jul 11, 2025
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.
This introduces the following changes:
Update the Read the Docs OS and Python versions
Fix local doc build errors caused by sqlalchemy-utils not being importable
Fix "unknown interpreted text role" warnings when building the docs
Root cause appears to be that autodoc reaches into parent classes to find docstrings for methods, but finds custom text roles used in the sqlalchemy class methods.
With these changes, the docs build cleanly when running
tox -e docslocally.