← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to BRANCH.TODO

  • Committer: John Arbash Meinel
  • Date: 2007-04-12 17:49:10 UTC
  • mto: This revision was merged to the branch mainline in revision 2566.
  • Revision ID: john@arbash-meinel.com-20070412174910-4m93s90gq6tjk1k4
Since I have epydoc working with lazy imports, make it the default api doc generator.
Also, update Makefile to make it easier to just document one file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
BRANCH.TODO
4
4
#
5
5
 
6
6
To build just one file's documentation you can use something like:
7
 
epydoc --html -o api --check --docformat "restructuredtext en" bzrlib/add.py
8
 
 
9
 
or you can use:
10
 
pydoctor --make-html --html-output=api/html --docformat "restructuredtext en" --add-module bzrlib/add.py
11
 
 
12
 
It will also generate Warnings describing why it isn't considered valid.
13
 
 
14
 
 
15
 
This is a list of current documentation failures.
16
 
These functions should be documented, and apis should be cleaned up.
 
7
make epydoc-api-docs docfiles=bzrlib/add.py
 
8
 
17
9
 
18
10
XXX unknown field <Field u'attr' u'_root_entrie' "<p>The root row of the direct>
19
11
XXX unknown field <Field u'range' None '<p>The range in the file</p>\>