Rev 2400: Update Makefile to add 'make api-docs' using pydoctor in http://bzr.arbash-meinel.com/branches/bzr/0.16-dev/doc-cleanup

John Arbash Meinel john at arbash-meinel.com
Mon Apr 9 21:26:09 BST 2007


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

------------------------------------------------------------
revno: 2400
revision-id: john at arbash-meinel.com-20070409202547-d2g38oke516pzbin
parent: pqm at pqm.ubuntu.com-20070404140524-48cdc6512763399e
committer: John Arbash Meinel <john at arbash-meinel.com>
branch nick: doc-cleanup
timestamp: Mon 2007-04-09 15:25:47 -0500
message:
  Update Makefile to add 'make api-docs' using pydoctor
added:
  pydoctor_bzrlib.cfg            pydoctor_bzrlib.cfg-20070404212742-5014t4yaxgygro9y-1
modified:
  .bzrignore                     bzrignore-20050311232317-81f7b71efa2db11a
  Makefile                       Makefile-20050805140406-d96e3498bb61c5bb
-------------- next part --------------
=== added file 'pydoctor_bzrlib.cfg'
--- a/pydoctor_bzrlib.cfg	1970-01-01 00:00:00 +0000
+++ b/pydoctor_bzrlib.cfg	2007-04-09 20:25:47 +0000
@@ -0,0 +1,5 @@
+projectname: BzrLib
+htmloutput: api/html
+htmlusesorttable: True
+packages: bzrlib
+docformat: restructuredtext

=== modified file '.bzrignore'
--- a/.bzrignore	2006-11-10 01:55:55 +0000
+++ b/.bzrignore	2007-04-09 20:25:47 +0000
@@ -33,3 +33,4 @@
 ./.perf_history
 ./html_docs
 ./pretty_docs
+./api

=== modified file 'Makefile'
--- a/Makefile	2007-01-30 12:45:50 +0000
+++ b/Makefile	2007-04-09 20:25:47 +0000
@@ -1,3 +1,25 @@
+# Copyright (C) 2005, 2006, 2007 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+# A relatively simple Makefile to assist in building parts of bzr. Mostly for
+# building documentation, etc.
+
+.PHONY: all clean pyflakes api-docs
+
+
 all:
 
 check:
@@ -23,7 +45,9 @@
 	-find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
 	rm -rf test????.tmp
 
-.PHONY: all
+api-docs:
+	mkdir -p api
+	pydoctor -c pydoctor_bzrlib.cfg --make-html
 
 
 # build emacs cross-reference



More information about the bazaar-commits mailing list