Commits

Kirill Simonov committed 94b177e

Split API documentation to a file per package.

Also, moved module headers to the module docstrings, disabled source
links on the compiled documentation pages.

Comments (0)

Files changed (46)

   HTSQL API
 =============
 
-:mod:`htsql`
-============
-.. automodule:: htsql
-   :members:
+Contents:
 
-:mod:`htsql.export`
-===================
-.. automodule:: htsql.export
-   :members:
+.. toctree::
+   :maxdepth: 2
 
-:mod:`htsql.util`
-=================
-.. automodule:: htsql.util
-   :members:
+   api/htsql
+   api/htsql_tr
+   api/htsql_ctl
+   api/htsql_sqlite
+   api/htsql_pgsql
 
-:mod:`htsql.validator`
-======================
-.. automodule:: htsql.validator
-   :members:
-
-:mod:`htsql.application`
-========================
-.. automodule:: htsql.application
-   :members:
-
-:mod:`htsql.context`
-====================
-.. automodule:: htsql.context
-   :members:
-
-:mod:`htsql.adapter`
-====================
-.. automodule:: htsql.adapter
-   :members:
-
-:mod:`htsql.addon`
-==================
-.. automodule:: htsql.addon
-   :members:
-
-:mod:`htsql.mark`
-=================
-.. automodule:: htsql.mark
-   :members:
-
-:mod:`htsql.error`
-==================
-.. automodule:: htsql.error
-   :members:
-
-:mod:`htsql.wsgi`
-=================
-.. automodule:: htsql.wsgi
-   :members:
-
-:mod:`htsql.connect`
-====================
-.. automodule:: htsql.connect
-   :members:
-
-:mod:`htsql.split_sql`
-======================
-.. automodule:: htsql.split_sql
-   :members:
-
-:mod:`htsql.tr`
-===============
-.. automodule:: htsql.tr
-   :members:
-
-:mod:`htsql.tr.token`
-=====================
-.. automodule:: htsql.tr.token
-   :members:
-
-:mod:`htsql.tr.scanner`
-=======================
-.. automodule:: htsql.tr.scanner
-   :members:
-
-:mod:`htsql.tr.syntax`
-======================
-.. automodule:: htsql.tr.syntax
-   :members:
-
-:mod:`htsql.tr.parser`
-======================
-.. automodule:: htsql.tr.parser
-   :members:
-
-:mod:`htsql.ctl`
-================
-.. automodule:: htsql.ctl
-   :members:
-
-:mod:`htsql.ctl.script`
-=======================
-.. automodule:: htsql.ctl.script
-   :members:
-
-:mod:`htsql.ctl.error`
-======================
-.. automodule:: htsql.ctl.error
-   :members:
-
-:mod:`htsql.ctl.option`
-=======================
-.. automodule:: htsql.ctl.option
-   :members:
-
-:mod:`htsql.ctl.routine`
-========================
-.. automodule:: htsql.ctl.routine
-   :members:
-
-:mod:`htsql.ctl.default`
-========================
-.. automodule:: htsql.ctl.default
-   :members:
-
-:mod:`htsql.ctl.version`
-========================
-.. automodule:: htsql.ctl.version
-   :members:
-
-:mod:`htsql.ctl.help`
-=====================
-.. automodule:: htsql.ctl.help
-   :members:
-
-:mod:`htsql.ctl.server`
-=======================
-.. automodule:: htsql.ctl.server
-   :members:
-
-:mod:`htsql.ctl.request`
-========================
-.. automodule:: htsql.ctl.request
-   :members:
-
-:mod:`htsql.ctl.shell`
-======================
-.. automodule:: htsql.ctl.shell
-   :members:
-
-:mod:`htsql.ctl.regress`
-========================
-.. automodule:: htsql.ctl.regress
-   :members:
-
-:mod:`htsql_sqlite`
-===================
-.. automodule:: htsql_sqlite
-   :members:
-
-:mod:`htsql_sqlite.export`
-==========================
-.. automodule:: htsql_sqlite.export
-   :members:
-
-:mod:`htsql_sqlite.connect`
-===========================
-.. automodule:: htsql_sqlite.connect
-   :members:
-
-:mod:`htsql_sqlite.split_sql`
-=============================
-.. automodule:: htsql_sqlite.split_sql
-   :members:
-
-:mod:`htsql_pgsql`
-==================
-.. automodule:: htsql_pgsql
-   :members:
-
-:mod:`htsql_pgsql.export`
-=========================
-.. automodule:: htsql_pgsql.export
-   :members:
-
-:mod:`htsql_pgsql.connect`
-==========================
-.. automodule:: htsql_pgsql.connect
-   :members:
-
-:mod:`htsql_pgsql.split_sql`
-============================
-.. automodule:: htsql_pgsql.split_sql
-   :members:
-

doc/api/htsql.rst

+============================
+  The :mod:`htsql` package
+============================
+
+.. automodule:: htsql
+   :members:
+.. automodule:: htsql.export
+   :members:
+.. automodule:: htsql.util
+   :members:
+.. automodule:: htsql.validator
+   :members:
+.. automodule:: htsql.application
+   :members:
+.. automodule:: htsql.context
+   :members:
+.. automodule:: htsql.adapter
+   :members:
+.. automodule:: htsql.addon
+   :members:
+.. automodule:: htsql.mark
+   :members:
+.. automodule:: htsql.error
+   :members:
+.. automodule:: htsql.wsgi
+   :members:
+.. automodule:: htsql.connect
+   :members:
+.. automodule:: htsql.split_sql
+   :members:
+

doc/api/htsql_ctl.rst

+================================
+  The :mod:`htsql.ctl` package
+================================
+
+.. automodule:: htsql.ctl
+   :members:
+.. automodule:: htsql.ctl.script
+   :members:
+.. automodule:: htsql.ctl.error
+   :members:
+.. automodule:: htsql.ctl.option
+   :members:
+.. automodule:: htsql.ctl.routine
+   :members:
+.. automodule:: htsql.ctl.default
+   :members:
+.. automodule:: htsql.ctl.version
+   :members:
+.. automodule:: htsql.ctl.help
+   :members:
+.. automodule:: htsql.ctl.server
+   :members:
+.. automodule:: htsql.ctl.request
+   :members:
+.. automodule:: htsql.ctl.shell
+   :members:
+.. automodule:: htsql.ctl.regress
+   :members:
+

doc/api/htsql_pgsql.rst

+==================================
+  The :mod:`htsql_pgsql` package
+==================================
+
+.. automodule:: htsql_pgsql
+   :members:
+.. automodule:: htsql_pgsql.export
+   :members:
+.. automodule:: htsql_pgsql.connect
+   :members:
+.. automodule:: htsql_pgsql.split_sql
+   :members:
+

doc/api/htsql_sqlite.rst

+===================================
+  The :mod:`htsql_sqlite` package
+===================================
+
+.. automodule:: htsql_sqlite
+   :members:
+.. automodule:: htsql_sqlite.export
+   :members:
+.. automodule:: htsql_sqlite.connect
+   :members:
+.. automodule:: htsql_sqlite.split_sql
+   :members:
+

doc/api/htsql_tr.rst

+===============================
+  The :mod:`htsql.tr` package
+===============================
+
+.. automodule:: htsql.tr
+   :members:
+.. automodule:: htsql.tr.token
+   :members:
+.. automodule:: htsql.tr.scanner
+   :members:
+.. automodule:: htsql.tr.syntax
+   :members:
+.. automodule:: htsql.tr.parser
+   :members:
+
 #html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
 
 # 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
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-=====================================
-  Welcome to HTSQL's documentation!
-=====================================
+===================================
+  Welcome to HTSQL documentation!
+===================================
 
 Contents:
 

src/htsql/__init__.py

 
 
 """
+:mod:`htsql`
+============
+
+:copyright: 2006-2010, Prometheus Research, LLC
+:authors: Clark C. Evans <cce@clarkevans.com>,
+          Kirill Simonov <xi@resolvent.net>
+:license: See ``LICENSE`` file in the source distribution
+
 This package provides HTSQL, a query language for the accidental programmer.
 
 HTSQL is implemented as a WSGI application.  To create an application, run::

src/htsql/adapter.py

 
 
 """
+:mod:`htsql.adapter`
+====================
+
 This module provides a mechanism for pluggable multiple dispatch.
 """
 

src/htsql/addon.py

 
 
 """
+:mod:`htsql.addon`
+==================
+
 This module declares HTSQL addons.
 """
 

src/htsql/application.py

 
 
 """
+:mod:`htsql.application`
+========================
+
 This module implements an HTSQL application.
 """
 

src/htsql/connect.py

 
 
 """
+:mod:`htsql.connect`
+====================
+
 This module declares the database connection adapter.
 
 This module exports a global variable:

src/htsql/context.py

 
 
 """
+:mod:`htsql.context`
+====================
+
 This module keeps the active HTSQL application in a thread-local variable.
 
 This module exports one global variable:

src/htsql/ctl/__init__.py

 
 
 """
+:mod:`htsql.ctl`
+================
+
 This package implements the ``htsql-ctl`` script.
 """
 

src/htsql/ctl/default.py

 
 
 """
+:mod:`htsql.ctl.default`
+========================
+
 This module implements the default routine.
 """
 

src/htsql/ctl/error.py

 
 
 """
+:mod:`htsql.ctl.error`
+======================
+
 This module implements exceptions raised by command-line scripts.
 """
 

src/htsql/ctl/help.py

 
 
 """
+:mod:`htsql.ctl.help`
+=====================
+
 This module implements the `help` routine.
 """
 

src/htsql/ctl/option.py

 
 
 """
+:mod:`htsql.ctl.option`
+=======================
+
 This module defines script options.
 """
 

src/htsql/ctl/regress.py

 
 
 """
+:mod:`htsql.ctl.regress`
+========================
+
 This module implements the `regress` routine.
 """
 

src/htsql/ctl/request.py

 
 
 """
+:mod:`htsql.ctl.request`
+========================
+
 This module implements the `get` and `post` routines.
 """
 

src/htsql/ctl/routine.py

 
 
 """
+:mod:`htsql.ctl.routine`
+========================
+
 This module defines basic classes for implementing script routines.
 """
 

src/htsql/ctl/script.py

 
 
 """
+:mod:`htsql.ctl.script`
+=======================
+
 This module implements a command-line application with subcommands.
 """
 

src/htsql/ctl/server.py

 
 
 """
+:mod:`htsql.ctl.server`
+=======================
+
 This module implements the `server` routine.
 """
 

src/htsql/ctl/shell.py

 
 
 """
+:mod:`htsql.ctl.shell`
+======================
+
 This module implements the `shell` routine.
 """
 

src/htsql/ctl/version.py

 
 
 """
+:mod:`htsql.ctl.version`
+========================
+
 This module implements the `version` routine.
 """
 

src/htsql/error.py

 
 
 """
+:mod:`htsql.error`
+==================
+
 This module implements HTSQL exceptions.
 """
 

src/htsql/export.py

 
 
 """
+:mod:`htsql.export`
+===================
+
 This module exports the `htsql.core` addon.
 """
 

src/htsql/mark.py

 
 
 """
+:mod:`htsql.mark`
+=================
+
 This module implements a :class:`Mark` object.
 """
 

src/htsql/split_sql.py

 
 
 """
+:mod:`htsql.split_sql`
+======================
+
 This module declares the SQL splitter adapter.
 
 This module exports a global variable:

src/htsql/tr/__init__.py

 
 
 """
+:mod:`htsql.tr`
+===============
+
 This package implements the HTSQL-to-SQL translator.
 """
 

src/htsql/tr/parser.py

 
 
 """
+:mod:`htsql.tr.parser`
+======================
+
 This module implements the HTSQL parser.
 """
 

src/htsql/tr/scanner.py

 
 
 """
+:mod:`htsql.tr.scanner`
+=======================
+
 This module implements the HTSQL scanner.
 """
 

src/htsql/tr/syntax.py

 
 
 """
+:mod:`htsql.tr.syntax`
+======================
+
 This module defines syntax nodes for the HTSQL grammar.
 """
 

src/htsql/tr/token.py

 
 
 """
+:mod:`htsql.tr.token`
+=====================
+
 This module defines token types used by the HTSQL scanner.
 """
 

src/htsql/util.py

 
 
 """
+:mod:`htsql.util`
+=================
+
 This module provides various hard-to-categorize utilities.
 """
 

src/htsql/validator.py

 
 
 """
+:mod:`htsql.validator`
+======================
+
 This module provides utilities for data validation and conversion.
 """
 

src/htsql/wsgi.py

 
 
 """
+:mod:`htsql.wsgi`
+=================
+
 This module provides a handler for WSGI requests.
 
 This module exports a global variable:

src/htsql_pgsql/__init__.py

 
 
 """
+:mod:`htsql_pgsql`
+==================
+
 This package provides HTSQL for PostgreSQL.
 """
 

src/htsql_pgsql/connect.py

 
 
 """
+:mod:`htsql_pgsql.connect`
+==========================
+
 This module implements the connection adapter for PostgreSQL.
 
 This module exports a global variable:

src/htsql_pgsql/export.py

 
 
 """
+:mod:`htsql_pgsql.export`
+=========================
+
 This module exports the `engine.pgsql` addon.
 """
 

src/htsql_pgsql/split_sql.py

 
 
 """
+:mod:`htsql_pgsql.split_sql`
+============================
+
 This module implements the SQL splitter for PostgreSQL.
 
 This module exports a global variable:

src/htsql_sqlite/__init__.py

 
 
 """
+:mod:`htsql_sqlite`
+===================
+
 This package provides HTSQL for SQLite.
 """
 

src/htsql_sqlite/connect.py

 
 
 """
+:mod:`htsql_sqlite.connect`
+===========================
+
 This module implements the connection adapter for SQLite.
 
 This module exports a global variable:

src/htsql_sqlite/export.py

 
 
 """
+:mod:`htsql_sqlite.export`
+==========================
+
 This module exports the `engine.sqlite` addon.
 """
 

src/htsql_sqlite/split_sql.py

 
 
 """
+:mod:`htsql_sqlite.split_sql`
+=============================
+
 This module implements the SQL splitter for SQLite.
 
 This module exports a global variable: