add initial docs

docs/Makefile

@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/edbob.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/edbob.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/edbob"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/edbob"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

docs/conf.py

@@ -0,0 +1,244 @@
+# -*- coding: utf-8 -*-
+#
+# edbob documentation build configuration file, created by
+# sphinx-quickstart on Sat Mar 24 19:40:38 2012.
+#
+# 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
+import edbob
+
+# 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.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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', 'sphinx.ext.todo']
+todo_include_todos = True
+
+# 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-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'edbob'
+copyright = u'2012, Lance Edgar <lance@edbob.org>'
+
+# 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 = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = edbob.__version__
+
+# 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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_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.  See the documentation for
+# a list of builtin themes.
+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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'edbobdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'edbob.tex', u'edbob Documentation',
+   u'Lance Edgar \\textless{}lance@edbob.org\\textgreater{}', '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
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'edbob', u'edbob Documentation',
+     [u'Lance Edgar <lance@edbob.org>'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'edbob', u'edbob Documentation',
+   u'Lance Edgar <lance@edbob.org>', 'edbob', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'

docs/edbob.commands.rst

@@ -0,0 +1,57 @@
+
+:mod:`edbob.commands`
+=====================
+
+.. automodule:: edbob.commands
+
+.. autofunction:: main
+
+Base Classes
+------------
+
+.. autoclass:: edbob.commands.Command
+
+   .. attribute:: name
+
+      The name for the command.  This should match the name of your
+      application.
+
+   .. attribute:: description
+
+      A short description of the command, used when displaying help.
+
+   .. attribute:: long_description
+
+      A longer description of the command, used when displaying help.
+
+   .. attribute:: subcommands
+
+      A dictionary of available subcommands, keyed by name.
+
+   .. attribute:: version
+
+      The version of the application for which the command exists.
+
+   .. automethod:: iter_subcommands
+
+   .. automethod:: print_help
+
+   .. automethod:: run
+
+.. autoclass:: edbob.commands.Subcommand
+
+   .. autoattribute:: name
+
+   .. autoattribute:: description
+
+   .. automethod:: add_parser_args
+
+   .. automethod:: run
+
+
+Core Commands
+-------------
+
+.. autoclass:: edbob.commands.ShellCommand
+
+.. autoclass:: edbob.commands.UuidCommand

docs/edbob.configuration.rst

@@ -0,0 +1,9 @@
+
+:mod:`edbob.configuration`
+==========================
+
+.. automodule:: edbob.configuration
+
+.. autofunction:: default_system_paths
+
+.. autofunction:: default_user_paths

docs/edbob.db.rst

@@ -0,0 +1,30 @@
+
+:mod:`edbob.db`
+===============
+
+.. automodule:: edbob.db
+
+.. attribute:: engines
+   
+   A dictionary of configured :class:`sqlalchemy.Engine` instances available to
+   the application.
+
+.. attribute:: engine
+
+   A reference to the default :class:`sqlalchemy.Engine` instance for the
+   application.
+
+.. attribute:: metadata
+
+   A reference to the global :class:`sqlalchemy.MetaData` instance for the
+   application.
+
+.. class:: Session
+
+   A :class:`sqlalchemy.orm.Session` class for use within the application.
+
+.. autofunction:: get_setting
+
+.. autofunction:: save_setting
+
+.. autofunction:: needs_session

docs/edbob.exceptions.rst

@@ -0,0 +1,6 @@
+
+:mod:`edbob.exceptions`
+=======================
+
+.. automodule:: edbob.exceptions
+   :members:

docs/edbob.mail.rst

@@ -0,0 +1,6 @@
+
+:mod:`edbob.mail`
+=================
+
+.. automodule:: edbob.mail
+   :members:

docs/edbob.modules.rst

@@ -0,0 +1,9 @@
+
+:mod:`edbob.modules`
+====================
+
+.. automodule:: edbob.modules
+
+.. autofunction :: import_module_path
+
+.. autofunction:: last_module

docs/edbob.rst

@@ -0,0 +1,86 @@
+
+:mod:`edbob`
+============
+
+.. automodule:: edbob
+
+
+Attributes
+----------
+
+This section lists the attributes available (by default) within the root
+``edbob`` namespace.
+
+.. attribute:: config
+
+   A reference to the global :class:`AppConfigParser` instance for the
+   currently-running application.
+
+   .. note::
+      This attribute is only available after :func:`edbob.init()` has happened.
+
+.. attribute:: inited
+
+   Boolean indicating whether or not :func:`edbob.init()` has happened.
+
+
+Functions
+---------
+
+This section lists the functions available (by default) within the root
+``edbob`` namespace.
+
+Core
+^^^^
+
+The following functions are considered "core" to ``edbob``:
+
+.. autofunction:: basic_logging
+
+.. autofunction:: entry_point_map
+
+.. autofunction:: get_uuid
+
+.. autofunction:: graft
+
+.. autofunction:: init
+
+.. autofunction:: load_spec
+
+Time
+^^^^
+
+The following functions provide some convenience when working with time values:
+
+.. autofunction:: local_time
+
+.. autofunction:: set_timezone
+
+.. autofunction:: utc_time
+
+Files
+^^^^^
+
+The following functions provide some convenience when working with files and
+folders:
+
+.. autofunction:: change_newlines
+
+.. autofunction:: count_lines
+
+.. autofunction:: temp_path
+
+Classes
+-------
+
+This section lists the classes available (by default) within the root ``edbob``
+namespace.
+
+.. autoclass:: Object
+
+   .. automethod:: __init__
+
+   .. automethod:: __getitem__
+
+.. autoclass:: AppConfigParser
+   :members:

docs/edbob.sqlalchemy.rst

@@ -0,0 +1,6 @@
+
+:mod:`edbob.sqlalchemy`
+=======================
+
+.. automodule:: edbob.sqlalchemy
+   :members:

docs/edbob.util.rst

@@ -0,0 +1,6 @@
+
+:mod:`edbob.util`
+=================
+
+.. automodule:: edbob.util
+   :members:

docs/index.rst

@@ -0,0 +1,43 @@
+
+edbob -- Pythonic Software Framework
+====================================
+
+Welcome to edbob, a Pythonic software framework released under the GNU Affero
+General Public License.
+
+It aims to be "environment-neutral" in that it can assist with development for
+console, web, or GUI applications.  Pay only for what you eat; however all of
+its functionality combined may be considered a "full stack" of sorts.
+
+
+API
+---
+
+The following pages describe the ``edbob`` package from a caller's perspective.
+
+.. toctree::
+   :maxdepth: 1
+
+   edbob
+   edbob.commands
+   edbob.configuration
+   edbob.db
+   edbob.exceptions
+   edbob.mail
+   edbob.modules
+   edbob.sqlalchemy
+   edbob.util
+
+
+To-Do
+-----
+
+.. todolist::
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,190 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\edbob.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\edbob.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end

edbob/commands.py

@@ -184,6 +184,26 @@ class Subcommand(edbob.Object):
             )
         self.add_parser_args(self.parser)
 
+    @property
+    @requires_impl(is_property=True)
+    def name(self):
+        """
+        The name of the subcommand.
+
+        .. note::
+           The subcommand name should ideally be limited to 12 characters in
+           order to preserve formatting consistency when displaying help text.
+        """
+        pass
+
+    @property
+    @requires_impl(is_property=True)
+    def description(self):
+        """
+        The description for the subcommand.
+        """
+        pass
+
     def __repr__(self):
         return "<Subcommand: %s>" % self.name
 
@@ -196,28 +216,6 @@ class Subcommand(edbob.Object):
         """
         pass
             
-    @property
-    @requires_impl(is_property=True)
-    def description(self):
-        """
-        The description for the subcommand.  This must be provided within your
-        subclass, as a simple class attribute.
-        """
-        pass
-
-    @property
-    @requires_impl(is_property=True)
-    def name(self):
-        """
-        The name of the subcommand.  This must be provided within your
-        subclass, as a simple class attribute.
-
-        .. note::
-           The subcommand name should ideally be limited to 12 characters in
-           order to preserve formatting consistency when displaying help text.
-        """
-        pass
-
     def _run(self, *args):
         args = self.parser.parse_args(list(args))
         return self.run(args)

edbob/modules.py

@@ -26,7 +26,6 @@
 ``edbob.modules`` -- Module Tools
 """
 
-
 import sys
 
 from edbob import exceptions
@@ -83,7 +82,6 @@ def load_spec(spec):
     necessary.
     """
 
-    
     module_path, obj = spec.split(':')
     module = import_module_path(module_path)
     try:

edbob/pyramid/scaffolds/edbob/+package+/commands.py_tmpl

@@ -39,7 +39,7 @@ class InitDatabaseCommand(commands.Subcommand):
     description = "Initialize the database"
 
     def run(self, args):
-        from edbob.db import engine, Session
+        from edbob.db import engine
         from edbob.db.util import install_core_schema
         from edbob.db.exceptions import CoreSchemaAlreadyInstalled
 
@@ -50,6 +50,9 @@ class InitDatabaseCommand(commands.Subcommand):
             print err
             return
 
+        # Activate any extensions you like here...
+
+        from edbob.db import Session
         from edbob.db.classes import Role, User
         from edbob.db.auth import administrator_role
 

edbob/sqlalchemy.py

@@ -50,11 +50,11 @@ def getset_factory(collection_class, proxy):
 
 def table_with_uuid(name, metadata, *args, **kwargs):
     """
+    .. highlight:: python
+
     Convenience function to abstract the addition of the ``uuid`` column to a
     new table.  Can be used to replace this::
 
-       .. highlight:: python
-
        Table(
            'things', metadata,
            Column('uuid', String(32), primary_key=True, default=get_uuid),

edbob/time.py

@@ -85,14 +85,14 @@ def set_timezone(tz):
     Sets edbob's notion of the "local" timezone.  ``tz`` should be an Olson
     name.
 
+    .. highlight:: ini
+
     You usually don't need to call this yourself, since it's called by
     :func:`edbob.init()` whenever the config file includes a timezone (but
     only as long as ``edbob.time`` is configured to be initialized)::
 
-       .. highlight:: ini
-
        [edbob]
-       init = ['edbob.time']
+       init = edbob.time
 
        [edbob.time]
        timezone = US/Central

edbob/util.py

@@ -52,4 +52,8 @@ class requires_impl(edbob.Object):
             msg += " (within the %s module)" % self.__class__.__module__
             raise NotImplementedError(msg)
 
+        # wrapped.__doc__ = func.__doc__ + "\n\n    This must be implemented by the derived class."
+        wrapped.__doc__ = """%s
+
+        This must be implemented by the derived class.""" % func.__doc__
         return wrapped