[Yum-devel] Yum documentation

Nick Jacek njacek at redhat.com
Wed Jun 29 15:17:39 UTC 2011


I've started working on documentation for yum, and I'd like to get feedback to make sure I'm on the right track in terms of what we want the documentation to look like.  I've started with the yumcommands module more or less arbitrarily.  What I've done so far is add much more extensive doc strings in the source code, and then use sphinx to automatically generate html.  Both the changed source code and the generated documentation are attached.

---
Nick Jacek
-------------- next part --------------
A non-text attachment was scrubbed...
Name: html.tar.gz
Type: application/x-compressed-tar
Size: 54975 bytes
Desc: not available
URL: <http://lists.baseurl.org/pipermail/yum-devel/attachments/20110629/9156da9c/attachment-0001.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: yumcommands.py
Type: text/x-python
Size: 96582 bytes
Desc: not available
URL: <http://lists.baseurl.org/pipermail/yum-devel/attachments/20110629/9156da9c/attachment-0001.py>


More information about the Yum-devel mailing list