Fix Python documentation generation#375
Merged
Merged
Conversation
rhui-dbx
approved these changes
Jul 13, 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.
Summary
async_Root cause
The Python backends embedded complex type roles inside
:paramfield names and wrapped long:ivarmarkers before their closing colon. Docutils parsed those as malformed field and definition lists. The client backend also formatted foreign types with the route namespace instead of the type's declaring namespace, producing references such asdropbox.team_log.TimeRangeanddropbox.files.PollError.This affects dropbox/dropbox-sdk-python#359, dropbox/dropbox-sdk-python#111, and part of dropbox/dropbox-sdk-python#516.
Impact
Generated Python API documentation uses valid reStructuredText and points to the correct modules. Runtime serialization and client behavior are unchanged.
Using this branch to regenerate the current Dropbox Python SDK reduced both HTML and man-page Sphinx warnings from 398 to 9. The remaining warnings come from handwritten SDK documentation or specification text, not Stone-generated field formatting.
Validation
pytest -q— 186 passedflake8 setup.py example stone testpylint --rcfile=.pylintrc setup.py example stone test— 10.00/10./mypy-run.sh— no issues in 59 files