desktopcouch

Merge lp://qastaging/~sil/desktopcouch/epydoc-documentation into lp://qastaging/desktopcouch

  1. epydoc-documentation
  2. Merge into trunk
Proposed by Stuart Langridge
Status: Merged
Approved by: Eric Casteleijn
Approved revision: not available
Merged at revision: not available
Proposed branch: lp://qastaging/~sil/desktopcouch/epydoc-documentation
Merge into: lp://qastaging/desktopcouch
Diff against target: 72 lines (+36/-3)
3 files modified
README (+6/-0)
data/epydoc.conf (+25/-0)
desktopcouch/start_local_couchdb.py (+5/-3)
To merge this branch: bzr merge lp://qastaging/~sil/desktopcouch/epydoc-documentation
Reviewer Review Type Date Requested Status
Eric Casteleijn (community) Approve
Nicola Larosa (community) Approve
Review via email: mp+16241@code.qastaging.launchpad.net

Commit message

Allow generation of full HTML API documentation, with "epydoc --config=data/epydoc.conf".

To post a comment you must log in.
Revision history for this message
Stuart Langridge (sil) wrote :

Allow generation of full HTML API documentation, with "epydoc --config=data/epydoc.conf". Tidy up a couple of small things to make this work properly.

We still don't have anywhere public to deploy this documentation, though.

Revision history for this message
Nicola Larosa (teknico) wrote :

Looks good.

+1 for making the generated docs public.

review: Approve
Revision history for this message
Eric Casteleijn (thisfred) wrote :

Looks great, documentation generation works, and tests keep passing.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'README'
2--- README 2009-08-07 12:43:11 +0000
3+++ README 2009-12-16 14:42:15 +0000
4@@ -2,6 +2,8 @@
5 and provide APIs and management tools for applications to store data within
6 it and share that data between computers and to the cloud.
7
8+Documentation and details at http://freedesktop.org/wiki/Specifications/desktopcouch
9+
10 = Technical notes =
11
12 == Creating databases, design documents, and views ==
13@@ -33,3 +35,7 @@
14 This is compatible with the filesystem view structure from CouchApp and
15 CouchDBKit.
16
17+=== Generating API documentation ===
18+
19+Run epydoc --config=data/epydoc.conf to create HTML documentation for the
20+whole desktopcouch API in docs/html/api.
21
22=== added file 'data/epydoc.conf'
23--- data/epydoc.conf 1970-01-01 00:00:00 +0000
24+++ data/epydoc.conf 2009-12-16 14:42:15 +0000
25@@ -0,0 +1,25 @@
26+[epydoc] # Epydoc section marker (required by ConfigParser)
27+
28+# Information about the project.
29+name: desktopcouch
30+url: http://www.freedesktop.org/wiki/Specifications/desktopcouch
31+
32+# The list of modules to document. Modules can be named using
33+# dotted names, module filenames, or package directory names.
34+# This option may be repeated.
35+modules: desktopcouch, desktopcouch.records
36+exclude: test
37+
38+# Write html output to the directory "apidocs"
39+output: html
40+target: docs/html/api/
41+
42+
43+parse: yes
44+introspect: no
45+
46+# Include all automatically generated graphs. These graphs are
47+# generated using Graphviz dot.
48+graph: all
49+dotpath: /usr/bin/dot
50+
51
52=== modified file 'desktopcouch/start_local_couchdb.py'
53--- desktopcouch/start_local_couchdb.py 2009-11-27 03:33:01 +0000
54+++ desktopcouch/start_local_couchdb.py 2009-12-16 14:42:15 +0000
55@@ -144,10 +144,12 @@
56 """Check system design documents and update any that need updating
57
58 A database should be created if
59- $XDG_DATA_DIRs/desktop-couch/databases/dbname/database.cfg exists
60+ $XDG_DATA_DIRs/desktop-couch/databases/dbname/database.cfg exists
61+
62 Design docs are defined by the existence of
63- $XDG_DATA_DIRs/desktop-couch/databases/dbname/_design/designdocname/views/viewname/map.js
64- reduce.js may also exist in the same folder.
65+ $XDG_DATA_DIRs/desktop-couch/databases/dbname/_design/designdocname/views/viewname/map.js
66+
67+ reduce.js may also exist in the same folder.
68 """
69 ctx_data_dir = os.path.split(ctx.db_dir)[0]
70 for base in itertools.chain([ctx_data_dir], xdg.BaseDirectory.xdg_data_dirs):
71
72=== added directory 'docs/html'

Subscribers

People subscribed via source and target branches