Kirill Simonov avatar Kirill Simonov committed 5af05a6

API documentation: include members automatically.

This change requires Sphinx 1.0.

Comments (0)

Files changed (5)

-HTSQL API
-=========
+=============
+  HTSQL API
+=============
 
 :mod:`htsql`
-------------
+============
 .. automodule:: htsql
+   :members:
 
 :mod:`htsql.export`
--------------------
+===================
 .. automodule:: htsql.export
-.. autoclass:: HTSQL_CORE
+   :members:
 
 :mod:`htsql.util`
------------------
+=================
 .. automodule:: htsql.util
-
-Connection parameters
-~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: DB
-   :members: parse, __str__
-
-Type checking helpers
-~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: maybe
-.. autoclass:: oneof
-.. autoclass:: listof
-.. autoclass:: tupleof
-.. autoclass:: dictof
-.. autoclass:: subclassof
-.. autoclass:: filelike
-.. autofunction:: aresubclasses
-
-Text formatting
-~~~~~~~~~~~~~~~
-.. autofunction:: trim_doc
-
-Topological sorting
-~~~~~~~~~~~~~~~~~~~
-.. autofunction:: toposort
-
+   :members:
 
 :mod:`htsql.validator`
-----------------------
+======================
 .. automodule:: htsql.validator
-.. autoclass:: Val
-.. autoclass:: AnyVal
-.. autoclass:: StrVal
-.. autoclass:: WordVal
-.. autoclass:: BoolVal
-.. autoclass:: IntVal
-.. autoclass:: UIntVal
-.. autoclass:: PIntVal
-.. autoclass:: DBVal
+   :members:
 
 :mod:`htsql.application`
-------------------------
+========================
 .. automodule:: htsql.application
-.. autoclass:: Application
-   :members: __call__, __enter__, __exit__
+   :members:
 
 :mod:`htsql.context`
---------------------
+====================
 .. automodule:: htsql.context
-.. autoclass:: ThreadContext
-   :members: switch, app
+   :members:
 
 :mod:`htsql.adapter`
---------------------
+====================
 .. automodule:: htsql.adapter
-.. autoclass:: Adapter
-   :members: __new__, realize
-.. autoclass:: Utility
-.. autoclass:: AdapterRegistry
-   :members: specialize
-.. autofunction:: adapts
-.. autofunction:: dominates
-.. autofunction:: dominated_by
-.. autofunction:: weights
-.. autofunction:: find_adapters
+   :members:
 
 :mod:`htsql.addon`
-------------------
+==================
 .. automodule:: htsql.addon
-.. autoclass:: Addon
+   :members:
 
 :mod:`htsql.mark`
------------------
+=================
 .. automodule:: htsql.mark
-.. autoclass:: Mark
-   :members: union, pointer
+   :members:
 
 :mod:`htsql.error`
-------------------
+==================
 .. automodule:: htsql.error
-.. autoexception:: HTTPError
-   :members: __call__
-
-Generic HTTP errors
-~~~~~~~~~~~~~~~~~~~
-.. autoexception:: BadRequestError
-.. autoexception:: ForbiddenError
-.. autoexception:: NotFoundError
-.. autoexception:: ConflictError
-.. autoexception:: InternalServerError
-.. autoexception:: NotImplementedError
-
-Concrete HTSQL Errors
-~~~~~~~~~~~~~~~~~~~~~
-.. autoexception:: InvalidSyntaxError
+   :members:
 
 :mod:`htsql.wsgi`
------------------
+=================
 .. automodule:: htsql.wsgi
-.. autoclass:: WSGI
-   :members: __call__
+   :members:
 
 :mod:`htsql.connect`
---------------------
+====================
 .. automodule:: htsql.connect
-.. autoexception:: DBError
-.. autoclass:: ErrorGuard
-.. autoclass:: ConnectionProxy
-   :members: cursor, commit, rollback, close
-.. autoclass:: CursorProxy
-   :members: description, rowcount, execute, executemany,
-             fetchone, fetchmany, fetchall, __iter__, close
-.. autoclass:: Connect
-   :members: __call__, open_connection, translate_error
+   :members:
 
 :mod:`htsql.split_sql`
-----------------------
+======================
 .. automodule:: htsql.split_sql
-.. autoclass:: SQLToken
-.. autoclass:: SplitSQL
-   :members: __call__
+   :members:
 
 :mod:`htsql.tr`
----------------
+===============
 .. automodule:: htsql.tr
+   :members:
 
 :mod:`htsql.tr.token`
----------------------
+=====================
 .. automodule:: htsql.tr.token
-.. autoclass:: Token
-   :members: unquote, quote
-.. autoclass:: SpaceToken
-.. autoclass:: NameToken
-.. autoclass:: StringToken
-.. autoclass:: NumberToken
-.. autoclass:: SymbolToken
-.. autoclass:: EndToken
+   :members:
 
 :mod:`htsql.tr.scanner`
------------------------
+=======================
 .. automodule:: htsql.tr.scanner
-.. autoclass:: TokenStream
-   :members: peek, pop
-.. autoclass:: Scanner
-   :members: scan
+   :members:
 
 :mod:`htsql.tr.syntax`
-----------------------
+======================
 .. automodule:: htsql.tr.syntax
-.. autoclass:: Syntax
-   :members: __str__
-.. autoclass:: QuerySyntax
-.. autoclass:: SegmentSyntax
-.. autoclass:: SelectorSyntax
-.. autoclass:: SieveSyntax
-.. autoclass:: OperatorSyntax
-.. autoclass:: FunctionOperatorSyntax
-.. autoclass:: FunctionCallSyntax
-.. autoclass:: GroupSyntax
-.. autoclass:: SpecifierSyntax
-.. autoclass:: IdentifierSyntax
-.. autoclass:: WildcardSyntax
-.. autoclass:: LiteralSyntax
-.. autoclass:: StringSyntax
-.. autoclass:: NumberSyntax
+   :members:
 
 :mod:`htsql.tr.parser`
-----------------------
+======================
 .. automodule:: htsql.tr.parser
-.. autoclass:: Parser
-   :members: parse, process
-.. autoclass:: QueryParser
-.. autoclass:: SegmentParser
-.. autoclass:: ElementParser
-.. autoclass:: TestParser
-.. autoclass:: AndTestParser
-.. autoclass:: ImpliesTestParser
-.. autoclass:: UnaryTestParser
-.. autoclass:: ComparisonParser
-.. autoclass:: ExpressionParser
-.. autoclass:: TermParser
-.. autoclass:: FactorParser
-.. autoclass:: PowerParser
-.. autoclass:: SieveParser
-.. autoclass:: SpecifierParser
-.. autoclass:: AtomParser
-.. autoclass:: GroupParser
-.. autoclass:: SelectorParser
-.. autoclass:: IdentifierParser
+   :members:
 
 :mod:`htsql.ctl`
-----------------
+================
 .. automodule:: htsql.ctl
-.. autoclass:: HTSQL_CTL
+   :members:
 
 :mod:`htsql.ctl.script`
------------------------
+=======================
 .. automodule:: htsql.ctl.script
-.. autoclass:: Script
-   :members: main, out, err, get_hint, get_help, get_copyright
+   :members:
 
 :mod:`htsql.ctl.error`
-----------------------
+======================
 .. automodule:: htsql.ctl.error
-.. autoexception:: ScriptError
+   :members:
 
 :mod:`htsql.ctl.option`
------------------------
+=======================
 .. automodule:: htsql.ctl.option
-.. autoclass:: Option
-   :members: get_hint, get_signature
+   :members:
 
 :mod:`htsql.ctl.routine`
-------------------------
+========================
 .. automodule:: htsql.ctl.routine
-.. autoclass:: Argument(attribute, validator, default=MANDATORY_ARGUMENT, is_list=False, hint=None)
-   :members: get_hint, get_signature
-.. autoclass:: Routine
-   :members: get_hint, get_help, get_signature, run
+   :members:
 
 :mod:`htsql.ctl.default`
-------------------------
+========================
 .. automodule:: htsql.ctl.default
-.. autoclass:: DefaultRoutine
+   :members:
 
 :mod:`htsql.ctl.version`
-------------------------
+========================
 .. automodule:: htsql.ctl.version
-.. autoclass:: VersionRoutine
+   :members:
 
 :mod:`htsql.ctl.help`
----------------------
+=====================
 .. automodule:: htsql.ctl.help
-.. autoclass:: HelpRoutine
+   :members:
 
 :mod:`htsql.ctl.server`
------------------------
+=======================
 .. automodule:: htsql.ctl.server
-.. autoclass:: ServerRoutine
+   :members:
 
 :mod:`htsql.ctl.request`
--------------------------
+========================
 .. automodule:: htsql.ctl.request
-.. autoclass:: Request
-   :members: prepare, execute
-.. autoclass:: Response
-   :members: set, complete, dump
-.. autoclass:: GetPostBaseRoutine
-.. autoclass:: GetRoutine
-.. autoclass:: PostRoutine
+   :members:
 
 :mod:`htsql.ctl.shell`
-----------------------
+======================
 .. automodule:: htsql.ctl.shell
-.. autoclass:: Cmd
-   :members: get_hint, get_help, get_signature, execute
-.. autoclass:: HelpCmd
-.. autoclass:: ExitCmd
-.. autoclass:: UserCmd
-.. autoclass:: HeadersCmd
-.. autoclass:: PagerCmd
-.. autoclass:: GetPostBaseCmd
-.. autoclass:: GetCmd
-.. autoclass:: PostCmd
-.. autoclass:: ShellState
-.. autoclass:: ShellRoutine
-   :members: get_help, get_intro, get_usage
+   :members:
 
 :mod:`htsql.ctl.regress`
-------------------------
+========================
 .. automodule:: htsql.ctl.regress
-.. autoclass:: TermStringIO
-.. autoclass:: Field(attribute, validator, default=MANDATORY_FIELD, hint=None)
-   :members: get_hint, get_signature
-.. autoclass:: AnyField
-.. autoclass:: TestData
-   :members: init_attributes
-.. autoclass:: TestCase
-   :members: get_hint, get_help, get_suites, matches,
-             ask, ask_halt, ask_record, ask_save,
-             out, out_exception, out_sep, out_header,
-             halted, failed, updated, passed,
-             verify, train
-.. autoclass:: RunAndCompareTestCase
-   :members: out_lines, out_diff, render, execute, differs
-.. autoclass:: SkipTestCase
-.. autoclass:: AppTestCase
-.. autoclass:: IncludeTestCase
-.. autoclass:: SuiteTestCase
-.. autoclass:: QueryTestCase
-.. autoclass:: CtlTestCase
-.. autoclass:: Fork
-   :members: start, end
-.. autoclass:: StartCtlTestCase
-.. autoclass:: EndCtlTestCase
-.. autoclass:: PythonCodeTestCase
-.. autoclass:: SQLTestCase
-   :members: load
-.. autoclass:: SQLIncludeTestCase
-.. autoclass:: WriteToFileTestCase
-.. autoclass:: ReadFromFileTestCase
-.. autoclass:: RemoveFilesTestCase
-.. autoclass:: MakeDirTestCase
-.. autoclass:: RemoveDirTestCase
-.. autoclass:: TestState
-   :members: push, pull
-.. autoclass:: RegressYAMLLoader
-   :members: load
-.. autoclass:: RegressYAMLDumper
-   :members: dump
-.. autoclass:: RegressRoutine
-   :members: get_help, get_feature
+   :members:
 
 :mod:`htsql_sqlite`
--------------------
+===================
 .. automodule:: htsql_sqlite
+   :members:
 
 :mod:`htsql_sqlite.export`
---------------------------
+==========================
 .. automodule:: htsql_sqlite.export
-.. autoclass:: ENGINE_SQLITE
+   :members:
 
 :mod:`htsql_sqlite.connect`
----------------------------
+===========================
 .. automodule:: htsql_sqlite.connect
-.. autoclass:: SQLiteError
-.. autoclass:: SQLiteConnect
+   :members:
 
 :mod:`htsql_sqlite.split_sql`
------------------------------
+=============================
 .. automodule:: htsql_sqlite.split_sql
-.. autoclass:: SplitSQLite
+   :members:
 
 :mod:`htsql_pgsql`
-------------------
+==================
 .. automodule:: htsql_pgsql
+   :members:
 
 :mod:`htsql_pgsql.export`
--------------------------
+=========================
 .. automodule:: htsql_pgsql.export
-.. autoclass:: ENGINE_PGSQL
+   :members:
 
 :mod:`htsql_pgsql.connect`
----------------------------
+==========================
 .. automodule:: htsql_pgsql.connect
-.. autoclass:: PGSQLError
-.. autoclass:: PGSQLConnect
+   :members:
 
 :mod:`htsql_pgsql.split_sql`
-----------------------------
+============================
 .. automodule:: htsql_pgsql.split_sql
-.. autoclass:: SplitPGSQL
+   :members:
 
-
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc']
 
+# Sort automatically documented members by source order (requires Sphinx 1.0).
+autodoc_member_order = 'bysource'
+
 # Add any paths that contain templates here, relative to this directory.
 #templates_path = ['_templates']
 
    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's documentation!
+=====================================
 
 Contents:
 

doc/reference.rst

-HTSQL Reference
-===============
+===================
+  HTSQL Reference
+===================
 
 (...)
 
-HTSQL Tutorial
-==============
+==================
+  HTSQL Tutorial
+==================
 
 (...)
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.