Bug 812197 - Include API docs in Sphinx documentation
Summary: Include API docs in Sphinx documentation
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: PulpDist
Classification: Community
Component: z_other
Version: unspecified
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: 0.1.0
Assignee: Nick Coghlan
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-04-13 04:10 UTC by Nick Coghlan
Modified: 2012-05-22 07:37 UTC (History)
0 users

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2012-05-22 07:37:02 UTC

Attachments (Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

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)
Note You need to log in before you can comment on or make changes to this bug.