summaryrefslogtreecommitdiff
path: root/epydoc.conf
diff options
context:
space:
mode:
authorHeikki Toivonen <heikki@heikkitoivonen.net>2009-08-07 01:16:28 +0000
committerHeikki Toivonen <heikki@heikkitoivonen.net>2009-08-07 01:16:28 +0000
commit11e5ae594890db8650bfe95c2784fafb9d09f795 (patch)
treec3a6f8cd12e47ebaf79d4d363c2f07dbc431c37c /epydoc.conf
parent8632f1f48dc181093aeeb11886c1fe78c772d20c (diff)
downloadm2crypto-11e5ae594890db8650bfe95c2784fafb9d09f795.tar.gz
Simplify document generation by using epydoc config file. Run with:
epydoc --no-private --config=epydoc.conf (for some reason the private options does not work in the config file). git-svn-id: http://svn.osafoundation.org/m2crypto/trunk@703 2715db39-9adf-0310-9c64-84f055769b4b
Diffstat (limited to 'epydoc.conf')
-rw-r--r--epydoc.conf29
1 files changed, 29 insertions, 0 deletions
diff --git a/epydoc.conf b/epydoc.conf
new file mode 100644
index 0000000..2afa556
--- /dev/null
+++ b/epydoc.conf
@@ -0,0 +1,29 @@
+# Copyright 2009 Heikki Toivonen. All rights reserved.
+# epydoc --no-private -v --config=epydoc.conf
+[epydoc]
+
+name = M2Crypto
+url = http://chandlerproject.org/Projects/MeTooCrypto
+
+output = html
+target = doc/api
+graph = all
+sourcecode = no
+private = no
+
+modules = ./M2Crypto
+
+# Private
+exclude-introspect = M2Crypto.__m2crypto
+
+# Variable shadows module, which causes the module to double in the doc
+# with second instance showing '. Exclude so we only get one (with ').
+exclude = M2Crypto.PGP.PublicKey
+exclude = M2Crypto.PGP.PublicKeyRing
+exclude = M2Crypto.PGP.packet
+exclude = M2Crypto.SSL.Cipher
+exclude = M2Crypto.SSL.Connection
+exclude = M2Crypto.SSL.Context
+exclude = M2Crypto.SSL.SSLServer
+exclude = M2Crypto.SSL.ssl_dispatcher
+exclude = M2Crypto.SSL.timeout