Rev 2403: Add command line invocations for epydoc and pydoctor to generate docs in http://bzr.arbash-meinel.com/branches/bzr/0.16-dev/doc-cleanup

[John Arbash Meinel]

At http://bzr.arbash-meinel.com/branches/bzr/0.16-dev/doc-cleanup

------------------------------------------------------------
revno: 2403
revision-id: john at arbash-meinel.com-20070409210437-qdyadcg1orpe5kkh
parent: john at arbash-meinel.com-20070409203609-xpvz574u8jj10q36
committer: John Arbash Meinel <john at arbash-meinel.com>
branch nick: doc-cleanup
timestamp: Mon 2007-04-09 16:04:37 -0500
message:
  Add command line invocations for epydoc and pydoctor to generate docs
  for a single file.
modified:
  BRANCH.TODO                    BRANCH.TODO-20060103052123-79ac4969351c03a9
-------------- next part --------------
=== modified file 'BRANCH.TODO'
--- a/BRANCH.TODO	2007-04-09 20:36:09 +0000
+++ b/BRANCH.TODO	2007-04-09 21:04:37 +0000
@@ -3,6 +3,15 @@
 # 
 #
 
+To build just one file's documentation you can use something like:
+epydoc --html -o api --check --docformat "restructuredtext en" bzrlib/add.py
+
+or you can use:
+pydoctor --make-html --html-output=api/html --docformat "restructuredtext en" --add-module bzrlib/add.py
+
+It will also generate Warnings describing why it isn't considered valid.
+
+
 This is a list of current documentation failures.
 These functions should be documented, and apis should be cleaned up.