Skip to content

Commit d1ae7c6

Browse files
committed
Better index page for driver docs
1 parent b22ca0a commit d1ae7c6

1 file changed

Lines changed: 48 additions & 1 deletion

File tree

docs/index.rst

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,55 @@
11
Python Cassandra Driver
22
=======================
3+
A Python client driver for `Apache Cassandra <http://cassandra.apache.org>`_.
4+
This driver works exclusively with the Cassandra Query Language v3 (CQL3)
5+
and Cassandra's native protocol. Cassandra 1.2+ is supported.
6+
7+
The driver supports Python 2.6, 2.7, 3.3, and 3.4.
8+
9+
This driver is open source under the
10+
`Apache v2 License <http://www.apache.org/licenses/LICENSE-2.0.html>`_.
11+
The source code for this driver can be found on `Github <http://github.com/datastax/python-driver>`_.
12+
13+
Contents
14+
--------
15+
:doc:`installation`
16+
How to install the driver.
17+
18+
:doc:`getting_started`
19+
A guide through the first steps of connecting to Cassandra and executing queries.
20+
21+
:doc:`api/index`
22+
The API documentation.
23+
24+
:doc:`upgrading`
25+
A guide to upgrading versions of the driver.
26+
27+
:doc:`performance`
28+
Tips for getting good performance.
29+
30+
:doc:`query_paging`
31+
Notes on paging large query results.
32+
33+
:doc:`security`
34+
An overview of the security features of the driver.
35+
36+
Getting Help
37+
------------
38+
Please send questions to the `mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_.
39+
40+
Alternatively, you can use IRC. Connect to the #datastax-drivers channel on irc.freenode.net.
41+
If you don't have an IRC client, you can use `freenode's web-based client <http://webchat.freenode.net/?channels=#datastax-drivers>`_.
42+
43+
Reporting Issues
44+
----------------
45+
Please report any bugs and make any feature requests on the
46+
`JIRA <https://datastax-oss.atlassian.net/browse/PYTHON>`_ issue tracker.
47+
48+
If you would like to contribute, please feel free to open a pull request.
49+
350

451
.. toctree::
5-
:maxdepth: 2
52+
:hidden:
653

754
api/index
855
installation

0 commit comments

Comments
 (0)