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.sphinxcontrib-autoapi: init at version 1.5.1 #98202

Merged
merged 1 commit into from Nov 16, 2020

Conversation

@karolchmist
Copy link
Contributor

@karolchmist karolchmist commented Sep 18, 2020

Motivation for this change

This adds Sphinx AutoAPI extension, which provides "autodoc" style documentation for multiple programming languages without needing to load, run, or import the project being documented.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
Copy link
Contributor

@jonringer jonringer left a comment

To comply with CONTRIBUTING.md please have the commit message name be of the format

<pkg-name>: <subject-line>

for more examples, please look at https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md#submitting-changes

in your case, the commit message should be:

python3Packages.sphinxcontrib-autoapi: init at 1.5.0
};

propagatedBuildInputs = [ astroid jinja2 pyyaml sphinx unidecode ];

This comment has been minimized.

@jonringer

jonringer Sep 18, 2020
Contributor

There are no tests included. Please try to checkout from source and check if they have unit tests, and try to run them. Unit tests give a good indication that they package has a high degree of validity and correctness given the python package set.

If tests are not available, then please use pythonImportsCheck to import the most important modules. This isn't as good as unit tests, but will usually give a good indication of run-time errors. Please see pythonImportsCheck documentation for more information.


----------------------------------------------------------------------
Ran 0 tests in 0.000s

This comment has been minimized.

@karolchmist

karolchmist Oct 15, 2020
Author Contributor

Thx @jonringer, I've added the tests.

@karolchmist karolchmist force-pushed the karolchmist:add-sphinx-autoapi branch from 49edd33 to dc1ee6e Oct 15, 2020
@karolchmist karolchmist changed the title sphinx autoapi: init at version 1.5.0 sphinx-autoapi: init at version 1.5.0 Oct 15, 2020
@karolchmist karolchmist changed the title sphinx-autoapi: init at version 1.5.0 python3Packages.sphinxcontrib-autoapi: init at version 1.5.0 Oct 18, 2020
@karolchmist karolchmist requested a review from jonringer Oct 18, 2020
@karolchmist
Copy link
Contributor Author

@karolchmist karolchmist commented Nov 10, 2020

Pinging @jonringer , can you please review again? I added the testing as requested.


meta = with stdenv.lib; {
homepage = "https://github.com/readthedocs/sphinx-autoapi";
description = "Sphinx AutoAPI provides 'autodoc' style documentation for multiple programming languages without needing to load, run, or import the project being documented.";

This comment has been minimized.

@jonringer

jonringer Nov 10, 2020
Contributor

Description should be short and succinct

Suggested change
description = "Sphinx AutoAPI provides 'autodoc' style documentation for multiple programming languages without needing to load, run, or import the project being documented.";
description = "Provides 'autodoc' style documentation";

if you want to have a long description, you can use longDescription

This comment has been minimized.

@karolchmist

karolchmist Nov 14, 2020
Author Contributor

Done. I didn't know about longDescription, thx!

@karolchmist karolchmist force-pushed the karolchmist:add-sphinx-autoapi branch from dc1ee6e to aac8f1e Nov 14, 2020
@karolchmist karolchmist changed the title python3Packages.sphinxcontrib-autoapi: init at version 1.5.0 python3Packages.sphinxcontrib-autoapi: init at version 1.5.1 Nov 14, 2020
@karolchmist karolchmist requested a review from jonringer Nov 16, 2020
Copy link
Contributor

@jonringer jonringer left a comment

LGTM

Result of nixpkgs-review pr 98202 1

2 packages built:
  • python37Packages.sphinxcontrib-autoapi
  • python38Packages.sphinxcontrib-autoapi

@jonringer jonringer merged commit 002a5f9 into NixOS:master Nov 16, 2020
17 checks passed
17 checks passed
tests
Details
action
Details
Evaluation Performance Report Evaluator Performance Report
Details
Wait for ofborg
Details
grahamcofborg-eval ^.^!
Details
grahamcofborg-eval-check-maintainers matching changed paths to changed attrs...
Details
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
grahamcofborg-eval-darwin nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="aac8f1e"; rev="aac8f1e1b94ef9bd846aa918458b9e1a1aa08552"; } ./pkgs/t
Details
grahamcofborg-eval-lib-tests nix-build --arg pkgs import ./. {} ./lib/tests/release.nix
Details
grahamcofborg-eval-nixos nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="aac8f1e"; rev="aac8f1e1b94ef9bd846aa918458b9e1a1aa08552"; } ./nixos/
Details
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="aac8f1e"; rev="aac8f1e1b94ef9bd846aa918458b9e1a1aa08552"; } ./nixos/
Details
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="aac8f1e"; rev="aac8f1e1b94ef9bd846aa918458b9e1a1aa08552"; } ./nixos/
Details
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="aac8f1e"; rev="aac8f1e1b94ef9bd846aa918458b9e1a1aa08552"; } ./pkgs/t
Details
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="aac8f1e"; rev="aac8f1e1b94ef9bd846aa918458b9e1a1aa08552"; } ./pkgs/t
Details
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="aac8f1e"; rev="aac8f1e1b94ef9bd846aa918458b9e1a1aa08552"; } ./pkgs/t
Details
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.