https://bugzilla.redhat.com/show_bug.cgi?id=2006555
Bug ID: 2006555
Summary: Review Request: python-autodocsumm - Extending your
autodoc API docs with a summary
Product: Fedora
Version: rawhide
Hardware: All
OS: Linux
Status: NEW
Component: Package Review
Severity: medium
Priority: medium
Assignee: [email protected]
Reporter: [email protected]
QA Contact: [email protected]
CC: [email protected]
Target Milestone: ---
Classification: Fedora
Spec URL: https://music.fedorapeople.org/python-autodocsumm.spec
SRPM URL:
https://music.fedorapeople.org/python-autodocsumm-0.2.7-1.fc34.src.rpm
Description:
This sphinx extension provides some useful extensions to the Sphinx autodoc
extension. Those are
1. It creates a Table of Contents in the style of the autosummary extension
with methods, classes, functions and attributes
2. As you can include the __init__ method documentation for via the
autoclass_content configuration value, we provide the autodata_content
configuration value to include the documentation from the __call__ method
3. You can exclude the string representation of specific objects. E.g. if
you have a large dictionary using the not_document_data configuration
value.
Fedora Account System Username: music
This will improve the documentation, and allow a patch to be dropped, in
python-marshmallow. It will also improve the (yet-to-be-packaged) documentation
in python-trimesh.
Koji scratch builds:
F36: https://koji.fedoraproject.org/koji/taskinfo?taskID=76076972
F35: https://koji.fedoraproject.org/koji/taskinfo?taskID=76077242
F34: https://koji.fedoraproject.org/koji/taskinfo?taskID=76077466
F33: https://koji.fedoraproject.org/koji/taskinfo?taskID=76077671
Notes on selected rpmlint messages:
> python-autodocsumm-doc.noarch: W: wrong-file-end-of-line-encoding
> /usr/share/doc/python-autodocsumm-doc/html/objects.inv
> python-autodocsumm-doc.noarch: W: file-not-utf8
> /usr/share/doc/python-autodocsumm-doc/html/objects.inv
The interpshinx inventory file objects.inv is not a text file, but it contains
enough text to fool rpmlint into complaining about it.
> python-autodocsumm.src:87: W: macro-in-%changelog %autochangelog
rpmlint does not understand rpmautospec
--
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=2006555
_______________________________________________
package-review mailing list -- [email protected]
To unsubscribe send an email to [email protected]
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/[email protected]
Do not reply to spam on the list, report it:
https://pagure.io/fedora-infrastructure