More docstrings plus configured autodoc, refs #311

docs/Makefile

@@ -20,4 +20,4 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 livehtml:
-	sphinx-autobuild -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(0)
+	sphinx-autobuild -a -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(0) --watch ../sqlite_utils

docs/conf.py

@@ -30,7 +30,8 @@ from subprocess import Popen, PIPE
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.extlinks"]
+extensions = ["sphinx.ext.extlinks", "sphinx.ext.autodoc"]
+autodoc_member_order = "bysource"
 
 extlinks = {
     "issue": ("https://github.com/simonw/sqlite-utils/issues/%s", "#"),

docs/index.rst

@@ -32,6 +32,7 @@ Contents
    installation
    cli
    python-api
+   reference
    contributing
    changelog
 

docs/reference.rst

@@ -0,0 +1,55 @@
+===========
+ Reference
+===========
+
+.. contents:: :local:
+
+.. _reference_db_database:
+
+sqlit_utils.db.Database
+=======================
+
+.. autoclass:: sqlite_utils.db.Database
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :special-members: __getitem__
+    :exclude-members: use_counts_table
+
+.. _reference_db_queryable:
+
+sqlit_utils.db.Queryable
+========================
+
+.. autoclass:: sqlite_utils.db.Queryable
+    :members:
+    :undoc-members:
+
+.. _reference_db_table:
+
+sqlit_utils.db.Table
+====================
+
+.. autoclass:: sqlite_utils.db.Table
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. _reference_db_view:
+
+sqlit_utils.db.View
+===================
+
+.. autoclass:: sqlite_utils.db.View
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. _reference_db_other:
+
+Other
+=====
+
+.. autoclass:: sqlite_utils.db.Column
+
+.. autoclass:: sqlite_utils.db.ColumnDetails