Launchpad itself

Merge lp:~jelmer/launchpad/pydoctor into lp:launchpad

  1. pydoctor
  2. Merge into devel
Proposed by Jelmer Vernooij on 2010-05-12
Status: Merged
Approved by: Michael Hudson-Doyle on 2010-05-12
Approved revision: no longer in the source branch.
Merged at revision: 10850
Proposed branch: lp:~jelmer/launchpad/pydoctor
Merge into: lp:launchpad
Diff against target: 33 lines (+10/-1)
2 files modified
.bzrignore (+1/-0)
Makefile (+9/-1)
To merge this branch: bzr merge lp:~jelmer/launchpad/pydoctor
Reviewer Review Type Date Requested Status
Michael Hudson-Doyle 2010-05-12 Approve on 2010-05-12
Review via email: mp+25133@code.launchpad.net

Commit Message

Add Makefile rule to generate API reference docs using pydoctor.

Description of the Change

This adds a trivial 'pydoctor' rule to the Launchpad Makefile that can generate HTML API documentation docs using pydoctor, similar to what Michael is generating on http://people.canonical.com/~mwh/canonicalapi/.

To post a comment you must log in.
Michael Hudson-Doyle (mwhudson) wrote :

Looks ok to me.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file '.bzrignore'
2--- .bzrignore 2010-03-26 21:23:34 +0000
3+++ .bzrignore 2010-05-12 09:44:37 +0000
4@@ -66,3 +66,4 @@
5 lp-clustered.sfood
6 lp-clustered.svg
7 lp.sfood
8+apidocs
9
10=== modified file 'Makefile'
11--- Makefile 2010-04-28 05:40:02 +0000
12+++ Makefile 2010-05-12 09:44:37 +0000
13@@ -436,6 +436,14 @@
14 dot -Tsvg < lp-clustered.dot > lp-clustered.svg.tmp
15 mv lp-clustered.svg.tmp lp-clustered.svg
16
17+PYDOCTOR = pydoctor
18+PYDOCTOR_OPTIONS =
19+
20+pydoctor:
21+ $(PYDOCTOR) --make-html --html-output=apidocs --add-package=lib/lp \
22+ --add-package=lib/canonical --project-name=Launchpad \
23+ --docformat restructuredtext --verbose-about epytext-summary \
24+ $(PYDOCTOR_OPTIONS)
25
26 .PHONY: apidoc check tags TAGS zcmldocs realclean clean debug stop\
27 start run ftest_build ftest_inplace test_build test_inplace pagetests\
28@@ -443,4 +451,4 @@
29 schema default launchpad.pot check_merge_ui pull scan sync_branches\
30 reload-apache hosted_branches check_db_merge check_mailman check_config\
31 jsbuild jsbuild_lazr clean_js buildonce_eggs \
32- sprite_css sprite_image css_combine compile check_schema
33+ sprite_css sprite_image css_combine compile check_schema pydoctor