Bug 2296242 - Review Request: python-sphinx-autoapi - Sphinx API documentation generator
Summary: Review Request: python-sphinx-autoapi - Sphinx API documentation generator
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Jerry James
QA Contact: Fedora Extras Quality Assurance
URL: https://github.com/readthedocs/sphinx...
Whiteboard:
Depends On:
Blocks: 2252167
TreeView+ depends on / blocked
 
Reported: 2024-07-08 05:51 UTC by Elliott Sales de Andrade
Modified: 2024-08-20 23:55 UTC (History)
2 users (show)

Fixed In Version: python-sphinx-autoapi-3.2.1-1.fc42
Clone Of:
Environment:
Last Closed: 2024-08-20 23:55:23 UTC
Type: ---
Embargoed:
loganjerry: fedora-review+


Attachments (Terms of Use)

Description Elliott Sales de Andrade 2024-07-08 05:51:13 UTC
Spec URL: https://qulogic.fedorapeople.org/reviews/python-sphinx-autoapi/python-sphinx-autoapi.spec
SRPM URL: https://qulogic.fedorapeople.org/reviews/python-sphinx-autoapi/python-sphinx-autoapi-3.1.2-1.fc39.src.rpm

Description:
Sphinx AutoAPI is a Sphinx extension for generating complete API documentation
without needing to load, run, or import the project being documented.

In contrast to the traditional Sphinx autodoc, which requires manual authoring
and uses code imports, AutoAPI finds and generates documentation by parsing
source code.


Koji scratch build: https://koji.fedoraproject.org/koji/taskinfo?taskID=120171484

Comment 1 Jerry James 2024-08-15 20:37:59 UTC
I will take this review.

Comment 2 Jerry James 2024-08-15 20:48:16 UTC
Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated

Issues:
=======
- Package must not depend on deprecated() packages.
  Note: python3-pytest7 is deprecated, you must not depend on it.
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/deprecating-packages/

  This is because python3dist(pytest) is a Provides of both pytest 7 and
  pytest 8.  As the root log shows, dnf picks pytest 8, so I don't think you
  need to do anything.

- Not really an issue, just curious: do you plan to use %autochangelog in
  conjunction with %autorelease?

- This is not the latest version.  Versions 3.2.0 and 3.2.1 have since been
  released.

===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "MIT License", "*No copyright* MIT
     License". 117 files have unknown license.
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: The License field must be a valid SPDX expression.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 3544 bytes in 1 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
[x]: Binary eggs must be removed in %prep

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[?]: Package functions as described.
[!]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-sphinx-autoapi-3.1.2-1.fc41.noarch.rpm
          python-sphinx-autoapi-3.1.2-1.fc41.src.rpm
================================================ rpmlint session starts ================================================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.12/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmp0512vo9v')]
checks: 32, packages: 2

python-sphinx-autoapi.src: E: spelling-error ('autodoc', '%description -l en_US autodoc -> auto doc, auto-doc, autodidact')
python3-sphinx-autoapi.noarch: E: spelling-error ('autodoc', '%description -l en_US autodoc -> auto doc, auto-doc, autodidact')
========== 2 packages and 0 specfiles checked; 2 errors, 0 warnings, 11 filtered, 2 badness; has taken 0.4 s ===========




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.13/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 1

python3-sphinx-autoapi.noarch: E: spelling-error ('autodoc', '%description -l en_US autodoc -> auto doc, auto-doc, autodidact')
 1 packages and 0 specfiles checked; 1 errors, 0 warnings, 7 filtered, 1 badness; has taken 0.1 s 



Source checksums
----------------
https://files.pythonhosted.org/packages/source/s/sphinx_autoapi/sphinx_autoapi-3.1.2.tar.gz :
  CHECKSUM(SHA256) this package     : fa5eb188f67ae39e19b2e7d2527c75d064e0f0b9ac7f77a3558ec26ccb731c26
  CHECKSUM(SHA256) upstream package : fa5eb188f67ae39e19b2e7d2527c75d064e0f0b9ac7f77a3558ec26ccb731c26


Requires
--------
python3-sphinx-autoapi (rpmlib, GLIBC filtered):
    python(abi)
    python3.13dist(astroid)
    python3.13dist(jinja2)
    python3.13dist(pyyaml)
    python3.13dist(sphinx)



Provides
--------
python3-sphinx-autoapi:
    python-sphinx-autoapi
    python3-sphinx-autoapi
    python3.13-sphinx-autoapi
    python3.13dist(sphinx-autoapi)
    python3dist(sphinx-autoapi)



Generated by fedora-review 0.10.0 (e79b66b) last change: 2023-07-24
Command line :/usr/bin/fedora-review -b 2296242 -m fedora-rawhide-x86_64
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Generic, Python
Disabled plugins: R, Ruby, Java, Ocaml, Perl, PHP, Haskell, SugarActivity, C/C++, fonts
Disabled flags: EXARCH, EPEL6, EPEL7, DISTTAG, BATCH

Comment 3 Elliott Sales de Andrade 2024-08-18 23:53:17 UTC
(In reply to Jerry James from comment #2)
> - Package must not depend on deprecated() packages.
>   Note: python3-pytest7 is deprecated, you must not depend on it.
>   See: https://docs.fedoraproject.org/en-US/packaging-
>   guidelines/deprecating-packages/
> 
>   This is because python3dist(pytest) is a Provides of both pytest 7 and
>   pytest 8.  As the root log shows, dnf picks pytest 8, so I don't think you
>   need to do anything.
> 
> - Not really an issue, just curious: do you plan to use %autochangelog in
>   conjunction with %autorelease?

Yes, that was accidentally left out.

> - This is not the latest version.  Versions 3.2.0 and 3.2.1 have since been
>   released.

Updated to 3.2.1.

Spec URL: https://qulogic.fedorapeople.org/reviews/2/python-sphinx-autoapi.spec
SRPM URL: https://qulogic.fedorapeople.org/reviews/2/python-sphinx-autoapi-3.2-1-1.fc39.src.rpm

Comment 5 Jerry James 2024-08-20 22:24:20 UTC
Looks good.  This package is APPROVED.

Comment 6 Elliott Sales de Andrade 2024-08-20 23:28:21 UTC
Thank you for the review, Jerry

Comment 7 Fedora Admin user for bugzilla script actions 2024-08-20 23:28:32 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/python-sphinx-autoapi

Comment 8 Fedora Update System 2024-08-20 23:41:18 UTC
FEDORA-2024-65660d0f2e (python-sphinx-autoapi-3.2.1-1.fc42) has been submitted as an update to Fedora 42.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-65660d0f2e

Comment 9 Fedora Update System 2024-08-20 23:48:22 UTC
FEDORA-2024-44bc473c92 (python-sphinx-autoapi-3.2.1-1.fc41) has been submitted as an update to Fedora 41.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-44bc473c92

Comment 10 Fedora Update System 2024-08-20 23:55:23 UTC
FEDORA-2024-65660d0f2e (python-sphinx-autoapi-3.2.1-1.fc42) has been pushed to the Fedora 42 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 11 Fedora Update System 2024-08-20 23:55:27 UTC
FEDORA-2024-44bc473c92 (python-sphinx-autoapi-3.2.1-1.fc41) has been pushed to the Fedora 41 stable repository.
If problem still persists, please make note of it in this bug report.


Note You need to log in before you can comment on or make changes to this bug.