Repository navigation
docs(api): fix the Sphinx warnings of module docstrings and PyQt signals - #533
Merged
Merged
Conversation
Sphinx reported "Unexpected indentation" on six module docstrings whose continuation lines were indented, and an unfinished emphasis on the unescaped *.dbconf of read_db_conf. Use a reStructuredText field list for the Name/Purpose/Author headers, dedent the others and put the glob in a literal. AI-Level: 7 AI-Model: Claude Sonnet 5.5 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CUNZAXTg3vthj5KZYCgf3m
Autodoc documents every pyqtSignal with PyQt's own docstring, whose "*types" docutils reads as an unfinished emphasis, producing a warning per signal. Remove it from the processed docstring, leaving the signals documented by a docstring of their own untouched. AI-Level: 7 AI-Model: Claude Sonnet 5.5 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CUNZAXTg3vthj5KZYCgf3m
github-actions
Bot
added
bug
|
Guts
enabled auto-merge
November 6, 2026 19:53
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #533 +/- ##
=======================================
Coverage 78.23% 78.23%
=======================================
Files 54 54
Lines 3469 3469
Branches 435 435
=======================================
Hits 2714 2714
Misses 633 633
Partials 122 122
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
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.
Description
Remove the Sphinx warnings that appeared on the API pages of
dicogis.uinow that PyQt6 is installed in the documentation build (#532):Name/Purpose/Authorheaders ofwdg_tab_publish,workers,progressandread_vector_flat_datasetbecome a reStructuredText field list, and the continuation lines ofui/mainandmw_dicogisare dedented;*.dbconfofread_db_confis put in a literal;*types, read as an unfinished emphasis: a smallautodoc-process-docstringhook indocs/conf.pydrops it and leaves the signals documented by hand untouched.The six docstrings were checked with docutils and the hook on a minimal Sphinx project; the full build has not been run locally (it needs GDAL), so the CI run of this PR is the confirmation.
Related issue(s)
Follows #532.
Type of change
fix/…branch)feature/…branch)docs/…branch or*.md/docs/**changes)packaging/…branch orbuilder/**changes)tooling/…branch or.github/**changes)tests/**changes)Checklist
pre-commit run --all-filespasses locallypytestpasses locallyAI/LLM disclosure
Generated by Claude Code