diff options
| author | Andi Albrecht <albrecht.andi@gmail.com> | 2013-01-01 10:22:29 +0100 |
|---|---|---|
| committer | Andi Albrecht <albrecht.andi@gmail.com> | 2013-01-01 10:22:29 +0100 |
| commit | a655298e76758a2c6114627d845b5e0b320e3734 (patch) | |
| tree | 7311377e540a7f24b77be62acadf88a331594cb2 /docs/source | |
| parent | 5bb5d2ae8b433adf7d3ffdd45b82c12c41eef435 (diff) | |
| download | sqlparse-a655298e76758a2c6114627d845b5e0b320e3734.tar.gz | |
Cleanup docs.
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/conf.py | 6 | ||||
| -rw-r--r-- | docs/source/index.rst | 50 | ||||
| -rw-r--r-- | docs/source/indices.rst | 7 |
3 files changed, 53 insertions, 10 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 30be096..5f7d34f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -96,7 +96,7 @@ pygments_style = 'tango' # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = 'agogo' +#html_theme = 'agogo' # 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 @@ -104,7 +104,7 @@ html_theme = 'agogo' #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [os.path.abspath('../')] +#html_theme_path = [os.path.abspath('../')] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". @@ -125,7 +125,7 @@ html_theme_path = [os.path.abspath('../')] # 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'] +#html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/docs/source/index.rst b/docs/source/index.rst index 44d03a2..18e48b3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,8 +3,39 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -python-sqlparse's documentation contents -======================================== +python-sqlparse +=============== + +:mod:`sqlparse` is a non-validating SQL parser for Python. +It provides support for parsing, splitting and formatting SQL statements. + +The module is compatible with Python 2 (>= 2.5) and Python 3 (>= 3.2) +and released under the terms of the `New BSD license +<http://www.opensource.org/licenses/bsd-license.php>`_. + +Visit the project page at https://github.com/andialbrecht/sqlparse for +further information about this project. + + +tl;rd +----- + +.. code-block:: bash + + $ pip install sqlparse + $ python + >>> import sqlparse + >>> print(sqlparse.format('select * from foo', reindent=True)) + select * + from foo + >>> parsed = sqlparse.parse('select * from foo')[0] + >>> parsed.tokens + [<DML 'select' at 0x7f22c5e15368>, <Whitespace ' ' at 0x7f22c5e153b0>, <Wildcard '*' … ] + >>> + + +Contents +-------- .. toctree:: :maxdepth: 2 @@ -14,12 +45,17 @@ python-sqlparse's documentation contents analyzing ui changes + indices + +Resources +--------- -Indices and tables -================== +Project page + https://github.com/andialbrecht/sqlparse -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +Bug tracker + https://github.com/andialbrecht/sqlparse/issues +Documentation + http://sqlparse.readthedocs.org/ diff --git a/docs/source/indices.rst b/docs/source/indices.rst new file mode 100644 index 0000000..f74c5d8 --- /dev/null +++ b/docs/source/indices.rst @@ -0,0 +1,7 @@ +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |
