Use sphinx's autodoc.

James William Pye · James William Pye · commit 422fd0758c8c · 2009-12-08T12:27:46.000-07:00
diff --git a/sphinx-src/Makefile b/sphinx-src/Makefile
@@ -23,7 +23,6 @@ help:
 clean:
 	-rm -rf *.txt
 	-rm -rf ../sphinx
-	-rm -f meta.py*
 
 html: dump
 	mkdir -p $(BUILD_DIR) $(BUILD_DIR)/doctrees
@@ -73,6 +72,6 @@ mkdirs:
 	mkdir -p .static .templates
 
 dump: mkdirs
-	cp ../postgresql/__init__.py ./meta.py
 	cp ../postgresql/documentation/*.txt ./
 	cp index.rst index.txt
+	cp modules.rst modules.txt
diff --git a/sphinx-src/conf.py b/sphinx-src/conf.py
@@ -13,18 +13,19 @@
 
 import sys, os
 sys.path.insert(0, '.')
+sys.dont_write_bytecode = True
 
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
-#sys.path.append(os.path.abspath('some/directory'))
+sys.path.append(os.path.abspath(os.path.dirname(__file__) + '../..'))
 
 # General configuration
 # ---------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
+extensions = ['sphinx.ext.autodoc']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
@@ -36,7 +37,7 @@
 master_doc = 'index'
 
 # General substitutions.
-import meta
+import postgresql as meta
 project = meta.__project__
 copyright = meta.__date__ + ', ' + meta.__author__
 
diff --git a/sphinx-src/index.rst b/sphinx-src/index.rst
@@ -8,7 +8,6 @@ using PostgreSQL.
 At its core, py-postgresql provides a PG-API, `postgresql.api`, and
 DB-API 2.0 interface for using a PostgreSQL database.
 
-
 Contents
 --------
 
@@ -19,10 +18,17 @@ Contents
    driver
    lib
    clientparameters
-   bin
    gotchas
    changes
 
+Reference
+---------
+
+.. toctree::
+   :maxdepth: 2
+
+   bin
+   modules
 
 Sample PG-API Code
 ------------------
diff --git a/sphinx-src/modules.rst b/sphinx-src/modules.rst
@@ -0,0 +1,22 @@
+Modules
+=======
+
+Modules intended for general use.
+
+:mod:`postgresql.string`
+------------------------
+
+.. automodule::
+    postgresql.string
+    :members:
+    :show-inheritance:
+
+
+:mod:`postgresql.types`
+-----------------------
+
+.. automodule::
+    postgresql.types
+    :members:
+    :show-inheritance:
+
