Edgewall Software

Opened 12 years ago

Last modified 9 years ago

#8695 closed enhancement

generate API documentation — at Initial Version

Reported by: anatoly techtonik <techtonik@…> Owned by:
Priority: normal Milestone: 1.0
Component: general Version: none
Severity: major Keywords: devguide api documentation
Cc: ryano@… Branch:
Release Notes:
API Changes:
Internal Changes:

Description

http://trac.edgewall.org/wiki/TracDev/PluginDevelopment lists available extension points, but doesn't describe parameters that are passed to extension point methods, such as req, env etc.

It should be possible to build API documentation automatically using Sphinx to extract docblocks. Additional specifiers can help limit/expand the scope of extracted information.

Change History (0)

Note: See TracTickets for help on using tickets.