Skip to content

Commit a9d21fc

Browse files
authored
Documentation cleanup (#1258)
1 parent 95cdc9a commit a9d21fc

File tree

4 files changed

+22
-24
lines changed

4 files changed

+22
-24
lines changed

README.rst

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44
.. |version| image:: https://badge.fury.io/py/cassandra-driver.svg
55
:target: https://badge.fury.io/py/cassandra-driver
66
.. |pyversion| image:: https://img.shields.io/pypi/pyversions/cassandra-driver.svg
7+
.. |travis| image:: https://api.travis-ci.com/datastax/python-driver.svg?branch=master
8+
:target: https://travis-ci.com/github/datastax/python-driver
79

8-
|license| |version| |pyversion|
10+
|license| |version| |pyversion| |travis|
911

1012
DataStax Driver for Apache Cassandra
1113
====================================
1214

13-
.. image:: https://travis-ci.com/datastax/python-driver.png?branch=master
14-
:target: https://travis-ci.com/github/datastax/python-driver
15-
1615
A modern, `feature-rich <https://github.com/datastax/python-driver#features>`_ and highly-tunable Python client library for Apache Cassandra (2.1+) and
1716
DataStax Enterprise (4.7+) using exclusively Cassandra's binary protocol and Cassandra Query Language v3.
1817

@@ -22,15 +21,15 @@ The driver supports Python 3.9 through 3.13.
2221

2322
Features
2423
--------
25-
* `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
26-
* `Simple, Prepared, and Batch statements <http://datastax.github.io/python-driver/api/cassandra/query.html#cassandra.query.Statement>`_
24+
* `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
25+
* `Simple, Prepared, and Batch statements <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/query/index.html#cassandra.query.Statement>`_
2726
* Asynchronous IO, parallel execution, request pipelining
28-
* `Connection pooling <http://datastax.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Cluster.get_core_connections_per_host>`_
27+
* `Connection pooling <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/cluster/index.html#cassandra.cluster.Cluster.get_core_connections_per_host>`_
2928
* Automatic node discovery
30-
* `Automatic reconnection <http://datastax.github.io/python-driver/api/cassandra/policies.html#reconnecting-to-dead-hosts>`_
31-
* 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>`_
32-
* `Concurrent execution utilities <http://datastax.github.io/python-driver/api/cassandra/concurrent.html>`_
33-
* `Object mapper <http://datastax.github.io/python-driver/object_mapper.html>`_
29+
* `Automatic reconnection <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/policies/index.html#reconnecting-to-dead-hosts>`_
30+
* 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>`_
31+
* `Concurrent execution utilities <https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/concurrent/index.html>`_
32+
* `Object mapper <https://docs.datastax.com/en/developer/python-driver/latest/object_mapper/>`_
3433
* `Connecting to DataStax Astra database (cloud) <https://docs.datastax.com/en/developer/python-driver/latest/cloud/>`_
3534
* DSE Graph execution API
3635
* DSE Geometric type serialization
@@ -43,24 +42,24 @@ Installation through pip is recommended::
4342
$ pip install cassandra-driver
4443

4544
For more complete installation instructions, see the
46-
`installation guide <http://datastax.github.io/python-driver/installation.html>`_.
45+
`installation guide <https://docs.datastax.com/en/developer/python-driver/latest/installation/index.html>`_.
4746

4847
Documentation
4948
-------------
50-
The documentation can be found online `here <http://datastax.github.io/python-driver/index.html>`_.
49+
The documentation can be found online `here <https://docs.datastax.com/en/developer/python-driver/latest/index.html>`_.
5150

5251
A couple of links for getting up to speed:
5352

54-
* `Installation <http://datastax.github.io/python-driver/installation.html>`_
55-
* `Getting started guide <http://datastax.github.io/python-driver/getting_started.html>`_
56-
* `API docs <http://datastax.github.io/python-driver/api/index.html>`_
57-
* `Performance tips <http://datastax.github.io/python-driver/performance.html>`_
53+
* `Installation <https://docs.datastax.com/en/developer/python-driver/latest/installation/index.html>`_
54+
* `Getting started guide <https://docs.datastax.com/en/developer/python-driver/latest/getting_started/index.html>`_
55+
* `API docs <https://docs.datastax.com/en/developer/python-driver/latest/api/index.html>`_
56+
* `Performance tips <https://docs.datastax.com/en/developer/python-driver/latest/performance/index.html>`_
5857

5958
Object Mapper
6059
-------------
6160
cqlengine (originally developed by Blake Eggleston and Jon Haddad, with contributions from the
6261
community) is now maintained as an integral part of this package. Refer to
63-
`documentation here <http://datastax.github.io/python-driver/object_mapper.html>`_.
62+
`documentation here <https://docs.datastax.com/en/developer/python-driver/latest/object_mapper/index.html>`_.
6463

6564
Contributing
6665
------------
@@ -79,9 +78,8 @@ If you would like to contribute, please feel free to open a pull request.
7978

8079
Getting Help
8180
------------
82-
Your best options for getting help with the driver are the
83-
`mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_
84-
and the `DataStax Community <https://community.datastax.com>`_.
81+
Your best options for getting help with the driver is the
82+
`mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_.
8583

8684
License
8785
-------

cassandra/cluster.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1700,7 +1700,7 @@ def protocol_downgrade(self, host_endpoint, previous_version):
17001700

17011701
log.warning("Downgrading core protocol version from %d to %d for %s. "
17021702
"To avoid this, it is best practice to explicitly set Cluster(protocol_version) to the version supported by your cluster. "
1703-
"http://datastax.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Cluster.protocol_version", self.protocol_version, new_version, host_endpoint)
1703+
"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)
17041704
self.protocol_version = new_version
17051705

17061706
def connect(self, keyspace=None, wait_for_all_pools=False):

cassandra/io/libevreactor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"The C extension needed to use libev was not found. This "
3030
"probably means that you didn't have the required build dependencies "
3131
"when installing the driver. See "
32-
"http://datastax.github.io/python-driver/installation.html#c-extensions "
32+
"https://docs.datastax.com/en/developer/python-driver/latest/installation/index.html#c-extensions "
3333
"for instructions on installing build dependencies and building "
3434
"the C extension.")
3535

docs/object_mapper.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Getting Started
6363
description = columns.Text(required=False)
6464
6565
#next, setup the connection to your cassandra server(s)...
66-
# see http://datastax.github.io/python-driver/api/cassandra/cluster.html for options
66+
# see https://docs.datastax.com/en/developer/python-driver/latest/api/cassandra/cluster.html for options
6767
# the list of hosts will be passed to create a Cluster() instance
6868
connection.setup(['127.0.0.1'], "cqlengine", protocol_version=3)
6969

0 commit comments

Comments
 (0)