Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

python3Packages.pdoc: init at 12.0.2 #181880

Merged
merged 1 commit into from
Sep 4, 2022
Merged

python3Packages.pdoc: init at 12.0.2 #181880

merged 1 commit into from
Sep 4, 2022

Conversation

pbsds
Copy link
Member

@pbsds pbsds commented Jul 17, 2022

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.

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 22.11 Release Notes (or backporting 22.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

@catern: Would you like to share maintainership between pdoc and pdoc3?

@ofborg ofborg bot added 8.has: package (new) This PR adds a new package 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels Jul 17, 2022
Copy link
Contributor

@yl3dy yl3dy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bobby285271 bobby285271 added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Jul 19, 2022
@onny
Copy link
Contributor

onny commented Sep 4, 2022

Result of nixpkgs-review pr 181880 run on x86_64-linux 1

2 packages built:
  • python310Packages.pdoc
  • python39Packages.pdoc

@onny onny merged commit b8f814b into NixOS:master Sep 4, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2022

Successfully created backport PR #189770 for release-22.05.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: python 8.has: package (new) This PR adds a new package 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 11.by: package-maintainer This PR was created by the maintainer of the package it changes 12.approvals: 1 This PR was reviewed and approved by one reputable person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants