pydoctor should have the equivalent of __docformat__ = "restructuredtext en"

Bug #410000 reported by Jean-Paul Calderone
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
pydoctor
Triaged
Low
Unassigned

Bug Description

Originally reported as Twisted issue 2187:

> epydoc has a epytext variant that's valid restructured text. You can either set __docformat__ = "restructuredtext en" in your module, or pass --docformat restructuredtext to epydoc to use it.

> pydoctor should support these as well, so that it can be a better drop-in replacement for epydoc. For instance, bzr's source uses restructuredtext format epytext, so pydoctor isn't hugely useful with it.

Revision history for this message
Michael Hudson-Doyle (mwhudson) wrote :

pydoctor has supported --docformat for ages now. It doesn't support __docformat__ in modules, but I don't know how much I care.

summary: - pydoctor should have the equivalent of "epydoc --docformat
- restructuredtext"
+ pydoctor should have the equivalent of __docformat__ = "restructuredtext
+ en"
Changed in pydoctor:
status: New → Triaged
importance: Undecided → Low
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.