Ticket #5 (closed Task: fixed)

Opened 6 years ago

Last modified 6 years ago

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

Changed 6 years ago by jjr8

  • description modified (diff)

Changed 6 years ago by jjr8

  • description modified (diff)

Changed 6 years ago by jjr8

  • status changed from new to closed
  • resolution set to fixed

Implemented in [56], not exactly according to the initial suggested implementation.

Developers write class, method, and property documentation in reStructuredText. The build process generates the docutils XML rendering of this in Metadata.xml. XSL is used to transform Metadata.xml directly into HTML pages that are the Python, ArcGIS and COM documentation.

The DevTeamNotes? property was deleted from the Metadata class. It was getting too confusing to try to have two versions of the documentation, one for the developers and one for the users. There will be just one version of the documentation, with flags indicating that classes, methods and properties are "internal" vs. "recommended for external callers".

Note: See TracTickets for help on using tickets.