Ticket #5 (closed Task: fixed)
setup.py should generate HTML documentation for all Python modules
| Reported by: | jjr8 | Owned by: | jjr8 |
|---|---|---|---|
| Priority: | High | Milestone: | 0.1 |
| Component: | Build System | Version: | null |
| Keywords: | Cc: |
Description (last modified by jjr8) (diff)
The suggested implementation is to use XSL to transform Metadata.xml into docutils XML and then use docutils to emit HTML.
Two sets of documentation should probably be generated:
- Python end-user documentation. This contains documentation of every module, class, method and property that is instrumented with metadata. If easy, it should be formatted as standard Python LaTeX HTML documentation. It should probably not include the DevNotes properties from the metadata.
- Developer documentation. Same as above but the DevNotes are not omitted.
Some users might want to see the DevNotes. Maybe just one set of documentation is fine.
Change History
Note: See
TracTickets for help on using
tickets.
