python3Packages.pdoc: init at 12.0.2 #181880
Merged
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 of changes
This PR adds the pdoc python module, used to generate API documenation of python modules using runtime inspection and static analysis.
We already package the fork known as pdoc3, but it is subject to a few controversies.
Nixpkgs favoring pdoc3 over pdoc is unfortunate, hence this PR.
pdoc has since the pdoc3 fork gotten much better, switching from using mako to instead use jinja2.
Currently I myself favor the quality of pdoc, but neither of the two are superior to the other, which is why I recommend we do not remove pdoc3 from nixpkgs.
Things done
I ran pdoc on a selection of python packages, the results of which are hosted here.
sandbox = true
set innix.conf
? (See Nix manual)nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"
. Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/
)nixos/doc/manual/md-to-db.sh
to update generated release notes@catern: Would you like to share maintainership between pdoc and pdoc3?