Repository navigation
Trim the docs configuration and show the real widget signatures - #107
Merged
Merged
Conversation
Drop the commented-out sphinx-quickstart defaults and the settings that Sphinx derives from project and author, and replace the hand-written urwid mock with Sphinx's autodoc_mock_imports. Both mocks hid the real constructor signatures of TreeBox and TreeListWalker, so containers.rst now states them: (tree, focus=None). The HTML pages are otherwise unchanged; the LaTeX, texinfo and man outputs are now titled "urwidtrees" instead of "urwidtrees Documentation". Co-Authored-By: Claude Opus 5.5 <[email protected]>
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.
docs/source/conf.pywas the 2015 sphinx-quickstart template: 168 of its 297 lines were commented-out defaults. This keeps only the values it sets and drops those Sphinx derives fromprojectandauthor(htmlhelp_basename,latex_documents,man_pages,texinfo_documents,master_doc). The hand-writtenMagicMockreplacement for urwid becomes Sphinx's ownautodoc_mock_imports.Both mocks hid the real constructor signatures of
TreeBoxandTreeListWalker: the old one showed the mock's eleven parameters, the new one would show(*args: Any, **kwargs: Any).containers.rstnow states them, so the docs show(tree, focus=None)for both.Built with Sphinx 9.2 (html, man, latex, texinfo,
-W), with and without urwid installed: the HTML pages are unchanged apart from those two signatures. The LaTeX, texinfo and man outputs are now titled "urwidtrees" instead of "urwidtrees Documentation", and the texinfo entry loses the quickstart placeholder's final full stop. The intersphinx link to the urwid docs now uses its current https address instead of a redirect.Review findings and resolution
review-correctness
(*args, **kwargs); it renders as(*args: Any, **kwargs: Any): superseded, as the real signatures are now stated.(tree, focus=None)signature was hidden before and after; suggested stating it incontainers.rst: fixed.-W, the removed settings being defaults.review-design
authormakes four output settings andmaster_docredundant: done..readthedocs.yaml: handled in a separate PR.🤖 Generated with Claude Code