[glom] Try to use sphinx for pyglom API documentation.

[Murray Cumming <murrayc src gnome org>]

commit f9199079df7a60e2d143727a7c4506f655bc2984
Author: Murray Cumming <murrayc murrayc com>
Date:   Fri Apr 16 16:58:54 2010 +0200

    Try to use sphinx for pyglom API documentation.
    
        * docs/pyglom_reference/Makefile.an:
    * docs/pyglom_reference/sphinx_sources/:
        An attempt to use sphinx instead of pydoc. sphinx is used by Python itself.
        I need to change my Python setup (not have Python in jhbuild) to test
        this properly, because I can't easily build pydoctor in my separate prefix.

 ChangeLog                                      |   10 ++
 docs/pyglom_reference/Makefile.am              |   13 ++-
 docs/pyglom_reference/sphinx_sources/api.rst   |   23 +++
 docs/pyglom_reference/sphinx_sources/conf.py   |  194 ++++++++++++++++++++++++
 docs/pyglom_reference/sphinx_sources/index.rst |   22 +++
 5 files changed, 259 insertions(+), 3 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 4575056..a53d8f8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,15 @@
 2010-04-16  Murray Cumming  <murrayc murrayc com>
 
+    Try to use sphinx for pyglom API documentation.
+
+    * docs/pyglom_reference/Makefile.an:
+	* docs/pyglom_reference/sphinx_sources/:
+    An attempt to use sphinx instead of pydoc. sphinx is used by Python itself.
+    I need to change my Python setup (not have Python in jhbuild) to test 
+    this properly, because I can't easily build pydoctor in my separate prefix. 
+
+2010-04-16  Murray Cumming  <murrayc murrayc com>
+
 	Python: Really show warnings when modules can't be imported.
 	
 	* glom/python_embed/glom_python.cc: Add and use import_module() to make sure 
diff --git a/docs/pyglom_reference/Makefile.am b/docs/pyglom_reference/Makefile.am
index b82df06..9f691da 100644
--- a/docs/pyglom_reference/Makefile.am
+++ b/docs/pyglom_reference/Makefile.am
@@ -1,9 +1,16 @@
 # pydoc can write docs for all modules in a directory (or a module name), 
 # but doesn't like being given a path to any actual file.
 
+
+# Using pydoc instead:
+# html:
+#	pydoc -w $(top_builddir)/glom/python_embed/python_module/.libs/
+#	mkdir html
+#	mv glom_1_14.html html/index.html
+
+ALLSPHINXOPTS   = -d _build/doctrees sphinx_sources
+
 html:
-	pydoc -w $(top_builddir)/glom/python_embed/python_module/.libs/
-	mkdir html
-	mv glom_1_14.html html/index.html
+	sphinx-build -b html $(ALLSPHINXOPTS) html
 
 MAINTAINERCLEANFILES = html/*
diff --git a/docs/pyglom_reference/sphinx_sources/api.rst b/docs/pyglom_reference/sphinx_sources/api.rst
new file mode 100644
index 0000000..2a579bd
--- /dev/null
+++ b/docs/pyglom_reference/sphinx_sources/api.rst
@@ -0,0 +1,23 @@
+The :mod:`glom_1_12` Module
+----------------------------
+
+.. automodule:: glom_1_14
+   :members:
+   :undoc-members:
+
+.. autoclass:: Record
+   :members:
+   :undoc-members:
+
+.. autoclass:: Related
+   :members:
+   :undoc-members:
+
+.. autoclass:: RelatedRecord
+   :members:
+   :undoc-members:
+
+.. autoclass:: UI
+   :members:
+   :undoc-members:
+
diff --git a/docs/pyglom_reference/sphinx_sources/conf.py b/docs/pyglom_reference/sphinx_sources/conf.py
new file mode 100644
index 0000000..e7430bd
--- /dev/null
+++ b/docs/pyglom_reference/sphinx_sources/conf.py
@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+#
+# glom_1_14 documentation build configuration file, created by
+# sphinx-quickstart on Fri Apr 16 16:21:26 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path 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('.'))
+
+# -- 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 = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'glom_1_14'
+copyright = u'2010, Murray Cumming'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.14.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.14.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'glom_1_14doc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'glom_1_14.tex', u'glom\\_1\\_14 Documentation',
+   u'Murray Cumming', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
diff --git a/docs/pyglom_reference/sphinx_sources/index.rst b/docs/pyglom_reference/sphinx_sources/index.rst
new file mode 100644
index 0000000..b5ac5aa
--- /dev/null
+++ b/docs/pyglom_reference/sphinx_sources/index.rst
@@ -0,0 +1,22 @@
+.. glom_1_14 documentation master file, created by
+   sphinx-quickstart on Fri Apr 16 16:21:26 2010.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to glom_1_14's documentation!
+=====================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+