[r3653]: trunk / docs / README.txt Maximize Restore History

Download this file

README.txt    50 lines (29 with data), 1.2 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
Document generation Guide
=========================

You need to install epydoc 3 first before go through this doc.

You could got epydoc source from epydoc svn::

    $ svn co https://svn.sourceforge.net/svnroot/epydoc

And follow epydoc's doc to install it.

Check Modules
-------------

To check what docs need to be written, use the command in source folder::

    $ epydoc --check tg

The command will gather all undocumented and no description python methods.

Generate Docs
-------------

To generate Turbogears2 API, use the command in source folder::

    $ epydoc --config docs/doc.ini

to generate API documents into tg2/apidoc folder.

You could custom the doc.ini setting to generate other type of docs.

Write Docs
----------

Note in TurboGears 2 we use reStructuredText format for doc strings.

It's a bit different from epydoc's default format.
Check docs about reStructuredText format on epydoc site.

http://epydoc.sourceforge.net/manual-docstring.html
http://epydoc.sourceforge.net/manual-othermarkup.html
http://epydoc.sourceforge.net/manual-fields.html

Debug Docs
-----------

To find where the format error is, use command::

    $ epydoc --config docs/doc.ini -v