Warning: Can't synchronize with repository "(default)" (Unsupported version control system "svn": No module named svn). Look in the Trac log for more information.

Ticket #1660 (closed defect: fixed)

Opened 11 years ago

Last modified 11 years ago

Investigate apydia for API docs

Reported by: mramm Owned by: anonymous
Priority: normal Milestone: 2.0
Component: TurboGears Version: trunk
Severity: normal Keywords:
Cc:

Description

Currently epydoc is sort of unmaintained so we should consider doing api docs with apydia.

Change History

comment:1 Changed 11 years ago by fredlin

Apydia looks good but not as promising as epydoc yet (37 commit at this time  http://apydia.ematia.de/svn/apydia/trunk/apydia/)

It's hard to say if Apydia will goes well or not, but it works with tg2 already :)

$ apydia -o tg --p restructuredtext -t TurboGears2

I'm bias to epydoc at this time because epydoc has 'epydoc check' function that able to guide us to complete the doc in source.

But I'll buy apydia if pylons want to replace pudge with apydia. Since apydia use genshi, which is nature to tg2.

comment:2 Changed 11 years ago by mramm

  • Status changed from new to closed
  • Resolution set to fixed

Fred proved that this can be done. I like the output of apydia better than epydoc, but sphinx seems like the best tool for us at the moment.

Note: See TracTickets for help on using tickets.