docs: fix all remaining docstring RST formatting for Sphinx/docutils compliance#154
Conversation
|
This PR appears to be the consolidated follow-up for the earlier split docfmt/docs cleanup PRs. I verified that its file set subsumes the work from #143 and #148-#153, so this is the main HIO docs/docstring cleanup branch to review for the current pass. For queue hygiene, I’m closing the superseded split PRs and leaving this one open as the aggregate review target. |
|
This now has conflicts after merged earlier pull requrests. Maybe I misunderstood the order. I merged the oldest ones first. |
…tils compliance - Fix unexpected indentation errors in 30+ source modules by converting free-form text blocks to proper RST list items and literal blocks - Add :no-index: directives to manual .rst pages to resolve duplicate-object warnings when autoapi covers the same symbols - Fix conf.py: expand autoapi_dirs from base/ to full hio package, remove undoc-members, guard sphinx.ext.viewcode against Python 3.14 crash - Add test.md to exclude_patterns - Minor README.md line-wrap cleanup and typo fixes in docstrings Build result: 0 warnings, 0 errors (clean from 303+ errors on upstream main)
d45f549 to
c5f9af1
Compare
|
Rebased onto current After rebase, the net diff is 11 files / 214 ins / 305 del (down from 39 files originally, since the split PRs already landed the rest). Verified locally:
Ready for review again. |
|
Queue note after re-checking the three open HIO PRs:
So from my side, |
|
I merged this one $154 so if the other two are obsolete please close them Thanks |
Summary
Completes the docstring RST cleanup started in wave-1 PRs (#137-#147). After this PR,
make -C docs htmlbuilds with 0 warnings and 0 errors (clean from 303+ errors on upstream main).Changes
Python source docstrings (30 files)
*, malformed``)converstion→conversion,accomodate→accommodate)Sphinx configuration (
docs/source/conf.py)autoapi_dirsfrombase/only to the fullhiopackage (all modules now covered)sphinx.ext.viewcodebehindsys.version_info < (3, 14)to fix a crash in Python 3.14undoc-membersfrom autoapi options (reduces noise)test.mdtoexclude_patternsManual RST pages (
docs/source/hio.*.rst):no-index:directives to manually-documented modules to resolve duplicate-object-description warnings when autoapi covers the same symbolsREADME.md
Verification
Pre-existing failures unrelated to this PR:
tests/base/test_filing.py::test_filing— path assertion against installed package (fails on main too)tests/core/memo/test_memoing.py— missingMemoerVerifyErrorin installed packagetests/help/test_timing.py— missingAsyncTimerin installed package