From ab8e2b3b901f69562b11790f966be40f500e3040 Mon Sep 17 00:00:00 2001 From: Andi Albrecht Date: Sat, 25 May 2019 09:39:50 +0200 Subject: Re-use parts of the README in documentation. --- docs/source/index.rst | 35 ++++++++--------------------------- docs/source/license.rst | 4 ++++ 2 files changed, 12 insertions(+), 27 deletions(-) create mode 100644 docs/source/license.rst (limited to 'docs/source') diff --git a/docs/source/index.rst b/docs/source/index.rst index 3c5956c..cba3314 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,33 +6,9 @@ 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.7 and Python 3 (>= 3.4) -and released under the terms of the `New BSD license -`_. - -Visit the project page at https://github.com/andialbrecht/sqlparse for -further information about this project. - - -tl;dr ------ - -.. 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 - [, , >> - +.. include:: ../../README.rst + :start-after: docincludebegin + :end-before: Links Contents -------- @@ -45,6 +21,7 @@ Contents analyzing ui changes + license indices @@ -59,3 +36,7 @@ Bug tracker Documentation https://sqlparse.readthedocs.io/ + +Online Demo + https://sqlformat.org/ + diff --git a/docs/source/license.rst b/docs/source/license.rst new file mode 100644 index 0000000..01f3963 --- /dev/null +++ b/docs/source/license.rst @@ -0,0 +1,4 @@ +License +======= + +.. include:: ../../LICENSE \ No newline at end of file -- cgit v1.2.1