[Bug 2384200] Review Request: python-autodocsumm - Extended sphinx autodoc including automatic autosummaries

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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



--- Comment #2 from Benson Muite <benson_muite@xxxxxxxxxxxxx> ---
(In reply to Karolina Surma from comment #1)
> 1. You can avoid bootstrapping the package by moving/adding this in the
> %install section to use the just installed package to generate the
> documentation (and then remove the BuildRequires on python3-autodocsumm as
> well as all the bconds).
> 
> pushd docs
> export PYTHONPATH=%{buildroot}%{python3_sitelib}
> sphinx-build -b texinfo . texinfo
> pushd texinfo
> makeinfo --docbook autodocsumm.texi
> install -pDm0644 autodocsumm.xml \
>   %{buildroot}%{_datadir}/help/en/autodocsumm/autodocsumm.xml
> popd
> popd
> 

Is this ok? Documentation is being built in the install step. Should all
building happen in the %build step?  If this is ok, maybe it is worth
updating the packaging guidelines to indicate documentation can be built
in the %install step?

At the moment have left as is, but happy to update.

spec: https://fed500.fedorapeople.org/python-autodocsumm.spec
srpm:
https://fed500.fedorapeople.org/python-autodocsumm-0.2.14-1.fc42~bootstrap.src.rpm 


A bootstrapped build is available at:
https://copr.fedorainfracloud.org/coprs/fed500/python-autodocsumm

> Out of curiosity: how can you consume the autodocsumm.xml file? Is there a
> CLI or GUI tool to display it nicely?
> 

It can be viewed in:

https://apps.gnome.org/Yelp/
https://packages.fedoraproject.org/pkgs/yelp/yelp/

https://apps.kde.org/khelpcenter/
https://packages.fedoraproject.org/pkgs/khelpcenter/khelpcenter

Happy to contribute tooling to pyp2spec if the documentation seems ok and would
be nice
for other Fedora packages.

> 2. Delete the leftover comment: "# Fill in the actual package description to
> submit package to Fedora"

Done.

> 
> 3. Consider adding doc file
> %doc README.rst

Done


-- 
You are receiving this mail because:
You are always notified about changes to this product and component
You are on the CC list for the bug.
https://bugzilla.redhat.com/show_bug.cgi?id=2384200

Report this comment as SPAM: https://bugzilla.redhat.com/enter_bug.cgi?product=Bugzilla&format=report-spam&short_desc=Report%20of%20Bug%202384200%23c2

-- 
_______________________________________________
package-review mailing list -- package-review@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to package-review-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/package-review@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite Conditions]     [KDE Users]

  Powered by Linux