Ticket #964 (new vote)
Proposal: Adopt "Sphinx" as PySoy docstring format
| Reported by: | ArcRiley | Owned by: | ArcRiley |
|---|---|---|---|
| Priority: | High | Milestone: | beta3 |
| Component: | Website (*.pysoy.org) | Version: | Trunk |
| Keywords: | Cc: |
Description
Python has adopted Sphinx as the standard documentation format starting with Python 2.6 (and 3.0).
Sphinx uses ReST formatting and offers many features over epydoc such as pygments code highlighting. By using Sphinx we can also remain as similar to Python core as possible.
This must be decided as a Trac plugin needs to be written for our standard and the codebase needs to be fully documented before beta-3 release.
Please comment to this ticket with discussion and (dis)support for this proposal.
Change History
Note: See
TracTickets for help on using
tickets.
