Move documentation to use sphinx.ext.autodoc - #1393
Open
r266-tech wants to merge 2 commits into
Open
Conversation
brettcannon
requested changes
Aug 24, 2026
brettcannon
left a comment
Member
There was a problem hiding this comment.
This isn't following the practices used in the rest of the repo for documentation even when autodoc is used.
| class PackageVcs: | ||
| """A package installed from a version control system. | ||
|
|
||
| :ivar str type: The version control system type. |
Member
There was a problem hiding this comment.
This :ivar stuff isn't used anywhere else and it pollutes the docstring such that help() becomes less readable.
Contributor
Author
|
Reworked this to follow the module-level I also kept the pylock frozen/keyword-only data-model contract in the module docstring and removed |
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.
This contribution advances #567 by moving duplicated API-reference text into source docstrings and rendering the
requirementsandpylockmodules through Sphinx autodoc.The review rework follows the module-level
automodulepattern established by #572 instead of listing individual classes and fields in the RST files. The pylock module docstring preserves the frozen, keyword-only dataclass contract, while class docstrings carry the field semantics without duplicateundoc-membersrendering.The changes remain limited to
docs/requirements.rst,docs/pylock.rst,src/packaging/requirements.py, andsrc/packaging/pylock.py.Verification:
uvx nox -s lintuvx nox -s docs(strict HTML and LaTeX builds; 418 doctests, 0 failures)git diff --check