Documentation cleanup (#1258)
diff --git a/README.rst b/README.rst index 8426fa3..f5085df 100644 --- a/README.rst +++ b/README.rst
@@ -4,15 +4,14 @@ .. |version| image:: https://badge.fury.io/py/cassandra-driver.svg :target: https://badge.fury.io/py/cassandra-driver .. |pyversion| image:: https://img.shields.io/pypi/pyversions/cassandra-driver.svg +.. |travis| image:: https://api.travis-ci.com/datastax/python-driver.svg?branch=master + :target: https://travis-ci.com/github/datastax/python-driver -|license| |version| |pyversion| +|license| |version| |pyversion| |travis| DataStax Driver for Apache Cassandra ==================================== -.. image:: https://travis-ci.com/datastax/python-driver.png?branch=master - :target: https://travis-ci.com/github/datastax/python-driver - A modern, `feature-rich <https://github.com/datastax/python-driver#features>`_ and highly-tunable Python client library for Apache Cassandra (2.1+) and DataStax Enterprise (4.7+) using exclusively Cassandra's binary protocol and Cassandra Query Language v3. @@ -22,15 +21,15 @@ Features -------- -* `Synchronous <http://datastax.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Session.execute>`_ and `Asynchronous <http://datastax.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Session.execute_async>`_ APIs -* `Simple, Prepared, and Batch statements <http://datastax.github.io/python-driver/api/cassandra/query.html#cassandra.query.Statement>`_ +* `Synchronous <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/cluster/index.html#cassandra.cluster.Session.execute>`_ and `Asynchronous <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/cluster/index.html#cassandra.cluster.Session.execute_async>`_ APIs +* `Simple, Prepared, and Batch statements <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/query/index.html#cassandra.query.Statement>`_ * Asynchronous IO, parallel execution, request pipelining -* `Connection pooling <http://datastax.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Cluster.get_core_connections_per_host>`_ +* `Connection pooling <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/cluster/index.html#cassandra.cluster.Cluster.get_core_connections_per_host>`_ * Automatic node discovery -* `Automatic reconnection <http://datastax.github.io/python-driver/api/cassandra/policies.html#reconnecting-to-dead-hosts>`_ -* Configurable `load balancing <http://datastax.github.io/python-driver/api/cassandra/policies.html#load-balancing>`_ and `retry policies <http://datastax.github.io/python-driver/api/cassandra/policies.html#retrying-failed-operations>`_ -* `Concurrent execution utilities <http://datastax.github.io/python-driver/api/cassandra/concurrent.html>`_ -* `Object mapper <http://datastax.github.io/python-driver/object_mapper.html>`_ +* `Automatic reconnection <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/policies/index.html#reconnecting-to-dead-hosts>`_ +* Configurable `load balancing <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/policies/index.html#load-balancing>`_ and `retry policies <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/policies/index.html#retrying-failed-operations>`_ +* `Concurrent execution utilities <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/concurrent/index.html>`_ +* `Object mapper <https://docs.datastax.com/en/developer/python-driver/latest/object_mapper/>`_ * `Connecting to DataStax Astra database (cloud) <https://docs.datastax.com/en/developer/python-driver/latest/cloud/>`_ * DSE Graph execution API * DSE Geometric type serialization @@ -43,24 +42,24 @@ $ pip install cassandra-driver For more complete installation instructions, see the -`installation guide <http://datastax.github.io/python-driver/installation.html>`_. +`installation guide <https://docs.datastax.com/en/developer/python-driver/latest/installation/index.html>`_. Documentation ------------- -The documentation can be found online `here <http://datastax.github.io/python-driver/index.html>`_. +The documentation can be found online `here <https://docs.datastax.com/en/developer/python-driver/latest/index.html>`_. A couple of links for getting up to speed: -* `Installation <http://datastax.github.io/python-driver/installation.html>`_ -* `Getting started guide <http://datastax.github.io/python-driver/getting_started.html>`_ -* `API docs <http://datastax.github.io/python-driver/api/index.html>`_ -* `Performance tips <http://datastax.github.io/python-driver/performance.html>`_ +* `Installation <https://docs.datastax.com/en/developer/python-driver/latest/installation/index.html>`_ +* `Getting started guide <https://docs.datastax.com/en/developer/python-driver/latest/getting_started/index.html>`_ +* `API docs <https://docs.datastax.com/en/developer/python-driver/latest/api/index.html>`_ +* `Performance tips <https://docs.datastax.com/en/developer/python-driver/latest/performance/index.html>`_ Object Mapper ------------- cqlengine (originally developed by Blake Eggleston and Jon Haddad, with contributions from the community) is now maintained as an integral part of this package. Refer to -`documentation here <http://datastax.github.io/python-driver/object_mapper.html>`_. +`documentation here <https://docs.datastax.com/en/developer/python-driver/latest/object_mapper/index.html>`_. Contributing ------------ @@ -79,9 +78,8 @@ Getting Help ------------ -Your best options for getting help with the driver are the -`mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_ -and the `DataStax Community <https://community.datastax.com>`_. +Your best options for getting help with the driver is the +`mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_. License -------
diff --git a/cassandra/cluster.py b/cassandra/cluster.py index 37dc659..bb1e5da 100644 --- a/cassandra/cluster.py +++ b/cassandra/cluster.py
@@ -1700,7 +1700,7 @@ log.warning("Downgrading core protocol version from %d to %d for %s. " "To avoid this, it is best practice to explicitly set Cluster(protocol_version) to the version supported by your cluster. " - "http://datastax.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Cluster.protocol_version", self.protocol_version, new_version, host_endpoint) + "https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/cluster.html#cassandra.cluster.Cluster.protocol_version", self.protocol_version, new_version, host_endpoint) self.protocol_version = new_version def connect(self, keyspace=None, wait_for_all_pools=False):
diff --git a/cassandra/io/libevreactor.py b/cassandra/io/libevreactor.py index d28c6af..76a8302 100644 --- a/cassandra/io/libevreactor.py +++ b/cassandra/io/libevreactor.py
@@ -29,7 +29,7 @@ "The C extension needed to use libev was not found. This " "probably means that you didn't have the required build dependencies " "when installing the driver. See " - "http://datastax.github.io/python-driver/installation.html#c-extensions " + "https://docs.datastax.com/en/developer/python-driver/latest/installation/index.html#c-extensions " "for instructions on installing build dependencies and building " "the C extension.")
diff --git a/docs/object_mapper.rst b/docs/object_mapper.rst index 4366c0a..21d2954 100644 --- a/docs/object_mapper.rst +++ b/docs/object_mapper.rst
@@ -63,7 +63,7 @@ description = columns.Text(required=False) #next, setup the connection to your cassandra server(s)... - # see http://datastax.github.io/python-driver/api/cassandra/cluster.html for options + # see https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/cluster.html for options # the list of hosts will be passed to create a Cluster() instance connection.setup(['127.0.0.1'], "cqlengine", protocol_version=3)