Bug 812197

Summary: Include API docs in Sphinx documentation
Product: [Community] PulpDist Reporter: Nick Coghlan <ncoghlan>
Component: z_otherAssignee: Nick Coghlan <ncoghlan>
Status: CLOSED NEXTRELEASE QA Contact:
Severity: medium Docs Contact:
Priority: medium    
Version: unspecified   
Target Milestone: 0.1.0   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-05-22 07:37:02 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Nick Coghlan 2012-04-13 04:10:54 UTC
The PulpDist Python package API currently isn't documented. A first pass at docs should be made simply by incorporating doc files generated with sphinx-autodoc.

http://sphinx.pocoo.org/man/sphinx-apidoc.html

Comment 1 Nick Coghlan 2012-05-22 07:37:02 UTC
Included for 0.0.16 (still somewhat sketchy due to missing docstrings, but that will be cleaned up over time)