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 #1659 (closed defect: fixed)

Opened 11 years ago

Last modified 11 years ago

create documentation generation system

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

Description (last modified by mramm) (diff)

I would like to have documentation written as markdown (or ReST) with references to code from sample TG2 project files. That way TG2 docs could have tested, working code, and could be automatically generated every release.

Some of this infrastructure exists in the SQLAlchemy project, so it might be interesting to steal that and go from there.

There's also been some interest in putting doc-generation like this into Apydia, so it might make sense to work with that project on this so it's reusable infrastructure.

Change History

comment:1 Changed 11 years ago by mramm

  • Description modified (diff)
  • Summary changed from create SQLAlchemy like documentation generation to create documentation generation system

comment:2 Changed 11 years ago by mramm

After some offline discussion with Kevin Dangoor and Bruce Eckel I think this should be it's own package, not pary of apydia, though we may want to work with apydia so the two can work together to provide a uber that prints both api docs and does manual doc generation tool.

With markdown and pygments this documentation tool would be useful for all kinds of projects and ultimately even non-python projects -- since it's just markdown and code-snipits.

The initialization stuff can be factored out, and put in comment like lines above the code snipit, and the tests for the code can be put in a block after the code snipit.

We can then use CSS to style these things out of the standard display. As I mentioned a good bit of this code is in the SQLAlchemy doc generation system already.

comment:3 Changed 11 years ago by mramm

Ha, we don't need to do this anymore sphinx seems to do everything we need it to, and it's used for the core python docs, so it should be well maintained ;)

comment:4 Changed 11 years ago by mramm

  • Status changed from new to closed
  • Resolution set to fixed
Note: See TracTickets for help on using tickets.