Bug 1981997 - Review Request: python-pydata-sphinx-theme - Bootstrap-based Sphinx theme from the PyData community
Summary: Review Request: python-pydata-sphinx-theme - Bootstrap-based Sphinx theme fro...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Ankur Sinha (FranciscoD)
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On: 1989300
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-07-13 22:56 UTC by Jerry James
Modified: 2021-09-24 20:08 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-09-24 20:08:13 UTC
Type: ---
Embargoed:
sanjay.ankur: fedora-review+


Attachments (Terms of Use)

Description Jerry James 2021-07-13 22:56:07 UTC
Spec URL: https://jjames.fedorapeople.org/python-pydata-sphinx-theme/python-pydata-sphinx-theme.spec
SRPM URL: https://jjames.fedorapeople.org/python-pydata-sphinx-theme/python-pydata-sphinx-theme-0.6.3-1.fc35.src.rpm
Fedora Account System Username: jjames
Description: This package contains a Sphinx extension for creating document components optimized for HTML+CSS.

- The panels directive creates panels of content in a grid layout, utilizing both the Bootstrap 4 grid system, and cards layout.

- The link-button directive creates a clickable button, linking to a URL or reference, and can also be used to make an entire panel clickable.

- The dropdown directive creates content that can be toggled.

- The tabbed directive creates tabbed content.

- opticon and fa (fontawesome) roles allow for inline icons to be added.

Comment 1 Ankur Sinha (FranciscoD) 2021-07-30 15:02:29 UTC
I'll review this now.

Could you review either of these please? They should both be straight forward reviews:

https://bugzilla.redhat.com/show_bug.cgi?id=1980562

or 

https://bugzilla.redhat.com/show_bug.cgi?id=1988265

Cheers,

Comment 2 Ankur Sinha (FranciscoD) 2021-07-30 16:23:19 UTC
Looks very good. A few minor issues worth looking into:

- licensecheck reports these. Does the license need to say "BSD and MIT"? (I thought this sort of scenario was documented somewhere but I can't seem to find the page at the moment.)

---

BSD (3 clause)
--------------
pydata-sphinx-theme-0.6.3/LICENSE

MIT License
-----------
pydata-sphinx-theme-0.6.3/pydata_sphinx_theme/static/css/index.c5995385ac14fb8791e8eb36b4908be2.css
pydata-sphinx-theme-0.6.3/pydata_sphinx_theme/static/js/index.1c5a1a01449ed65a7b51.js

---

- these two are from the bundled bootstrap and "kickass" libraries that seem to be bundled.
- it bundles fontawesome in pydata_sphinx_theme/static/vendor/fontawesome/5.13.0/ which also has it's own license(s) and may need a look

I think we'll also need to document these as bundled in the spec.

Package Review
==============

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


Issues:
=======
- 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.
  Note: License file LICENSE.txt is not marked as %license
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/LicensingGuidelines/#_license_text


^
Noted above.

===== 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.
[?]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "BSD (3 clause)", "*No copyright*
     [generated file]", "MIT License". 155 files have unknown license.
     Detailed output of licensecheck in /home/asinha/dump/fedora-
     reviews/1981997-python-pydata-sphinx-theme/1981997-python-pydata-
     sphinx-theme/licensecheck.txt
^
Noteda above

[x]: License file installed when any subpackage combination is installed.
[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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 1 files.
[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]: 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 must not depend on deprecated() packages.
[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]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Python eggs must not download any dependencies during the build
     process.
[-]: 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:
[?]: Avoid bundling fonts in non-fonts packages.
     Note: Package contains font files
^
noted above, bundles fontawesome

[-]: 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).
[-]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python3-pydata-sphinx-theme
[x]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[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-pydata-sphinx-theme-0.6.3-1.fc35.noarch.rpm
          python-pydata-sphinx-theme-doc-0.6.3-1.fc35.noarch.rpm
          python-pydata-sphinx-theme-0.6.3-1.fc35.src.rpm
python3-pydata-sphinx-theme.noarch: W: spelling-error %description -l en_US dropdown -> drop down, drop-down, drown
python3-pydata-sphinx-theme.noarch: W: spelling-error %description -l en_US opticon -> option, opt icon, opt-icon
python3-pydata-sphinx-theme.noarch: E: zero-length /usr/lib/python3.10/site-packages/pydata_sphinx_theme/docs-sidebar.html
python-pydata-sphinx-theme.src: W: spelling-error %description -l en_US dropdown -> drop down, drop-down, drown
python-pydata-sphinx-theme.src: W: spelling-error %description -l en_US opticon -> option, opt icon, opt-icon
python-pydata-sphinx-theme.src: W: spelling-error %description -l en_US fontawesome -> font awesome, font-awesome, awesomeness
3 packages and 0 specfiles checked; 1 errors, 5 warnings.
^
All OK.


Rpmlint (installed packages)
----------------------------
Cannot parse rpmlint output: ?

^
Hrm, not sure what's going on here.


Source checksums
----------------
https://github.com/pydata/pydata-sphinx-theme/archive/v0.6.3/pydata-sphinx-theme-0.6.3.tar.gz :
  CHECKSUM(SHA256) this package     : c5e33c92ab3524327b7f07b46768d4765124101ea6112379755cc72e050b49d8
  CHECKSUM(SHA256) upstream package : c5e33c92ab3524327b7f07b46768d4765124101ea6112379755cc72e050b49d8


Requires
--------
python3-pydata-sphinx-theme (rpmlib, GLIBC filtered):
    python(abi)
    python3.10dist(beautifulsoup4)
    python3.10dist(docutils)
    python3.10dist(sphinx)

python-pydata-sphinx-theme-doc (rpmlib, GLIBC filtered):



Provides
--------
python3-pydata-sphinx-theme:
    python-pydata-sphinx-theme
    python3-pydata-sphinx-theme
    python3.10-pydata-sphinx-theme
    python3.10dist(pydata-sphinx-theme)
    python3dist(pydata-sphinx-theme)

python-pydata-sphinx-theme-doc:
    python-pydata-sphinx-theme-doc



Generated by fedora-review 0.7.6 (b083f91) last change: 2020-11-10
Command line :/usr/bin/fedora-review -b 1981997 -o --no-cleanup-after --no-clean --enablerepo=local
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Generic, Python
Disabled plugins: PHP, fonts, SugarActivity, C/C++, Perl, R, Haskell, Java, Ocaml
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 3 Jerry James 2021-07-30 20:26:26 UTC
I almost have everything fixed, but I need some advice on one issue.  I attempted to unbundle fontawesome, only to discover that this package needs fontawesome 5.x, but Fedora is stuck on fontawesome 4.x.  See bug 1857488 and bug 1960052.  I am not eager to take over the fontawesome-fonts package, nor figure out how to port packages that need 4.x to 5.x.  I just want this package. :-)

So how should I proceed?  Leave fontawesome bundled for now until somebody takes on the job of migrating the fontawesome-fonts package to 5.x?

Comment 4 Ankur Sinha (FranciscoD) 2021-08-02 08:47:16 UTC
Yes, I think leaving fontawesome bundled is the best and simplest way forward here for the time being.

Comment 5 Jerry James 2021-08-05 23:32:42 UTC
Actually, I am going to try to get fontawesome version 5 into Fedora first, then proceed with this review.  See bug 1989300.

Comment 6 Jerry James 2021-08-23 21:06:25 UTC
The fontawesome5-fonts package is now available in F35 and Rawhide.  New URLs for this package to take advantage of that:

Spec URL: https://jjames.fedorapeople.org/python-pydata-sphinx-theme/python-pydata-sphinx-theme.spec
SRPM URL: https://jjames.fedorapeople.org/python-pydata-sphinx-theme/python-pydata-sphinx-theme-0.6.3-2.fc36.src.rpm

Comment 7 Ankur Sinha (FranciscoD) 2021-08-24 09:00:56 UTC
OK, that looks good. 

Rpmlint
-------
Checking: python3-pydata-sphinx-theme-0.6.3-2.fc36.noarch.rpm
          python-pydata-sphinx-theme-doc-0.6.3-2.fc36.noarch.rpm
          python-pydata-sphinx-theme-0.6.3-2.fc36.src.rpm
python3-pydata-sphinx-theme.noarch: W: spelling-error %description -l en_US dropdown -> drop down, drop-down, drown
python3-pydata-sphinx-theme.noarch: W: spelling-error %description -l en_US opticon -> option, opt icon, opt-icon
python3-pydata-sphinx-theme.noarch: W: spelling-error %description -l en_US fontawesome -> font awesome, font-awesome, awesomeness
python3-pydata-sphinx-theme.noarch: E: zero-length /usr/lib/python3.10/site-packages/pydata_sphinx_theme/docs-sidebar.html
python-pydata-sphinx-theme.src: W: spelling-error %description -l en_US dropdown -> drop down, drop-down, drown
python-pydata-sphinx-theme.src: W: spelling-error %description -l en_US opticon -> option, opt icon, opt-icon
python-pydata-sphinx-theme.src: W: spelling-error %description -l en_US fontawesome -> font awesome, font-awesome, awesomeness
3 packages and 0 specfiles checked; 1 errors, 6 warnings.



There's a zero length file here, but I expect it's part of the theme. Worth a look before importing.

XXX APPROVED XXX

Comment 8 Jerry James 2021-08-25 14:37:31 UTC
Thank you, Ankur!

Comment 9 Gwyn Ciesla 2021-08-25 14:46:18 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-pydata-sphinx-theme

Comment 10 Fedora Update System 2021-08-25 16:21:31 UTC
FEDORA-2021-4a0b27b74a has been submitted as an update to Fedora 35. https://bodhi.fedoraproject.org/updates/FEDORA-2021-4a0b27b74a

Comment 11 Fedora Update System 2021-08-25 18:37:32 UTC
FEDORA-2021-4a0b27b74a has been pushed to the Fedora 35 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2021-4a0b27b74a \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-4a0b27b74a

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 12 Fedora Update System 2021-09-24 20:08:13 UTC
FEDORA-2021-4a0b27b74a has been pushed to the Fedora 35 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.