Skip to content

Commit 1ec0f54

Browse files
committed
Documentation: Improve "Examples" section on index page
1 parent 7314e37 commit 1ec0f54

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/index.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,15 +116,16 @@ Examples
116116
- The :ref:`by-example` section enumerates concise examples demonstrating the
117117
different API interfaces of the CrateDB Python client library. Those are
118118
DB API, HTTP, and BLOB interfaces.
119+
119120
- Executable code examples are maintained within the `cratedb-examples repository`_.
121+
`sqlalchemy-cratedb`_, `python-dataframe-examples`_, and `python-sqlalchemy-examples`_
122+
provide relevant code snippets about how to connect to CrateDB using
123+
`SQLAlchemy`_, `pandas`_, or `Dask`_, and how to load and export data.
124+
120125
- The `sample application`_ and the corresponding `sample application
121126
documentation`_ demonstrate the use of the driver on behalf of an example
122-
"guestbook" application.
123-
- ``sqlalchemy-cratedb`` has relevant code snippets about how to
124-
connect to CrateDB using `SQLAlchemy`_, `pandas`_, and `Dask`_.
125-
- `Use CrateDB with pandas`_ has corresponding code snippets about how to
126-
connect to CrateDB using `pandas`_, and how to load and export data.
127-
- The `Apache Superset`_ and `FIWARE QuantumLeap data historian`_ projects.
127+
"guestbook" application, using Flask.
128+
128129

129130
.. toctree::
130131
:maxdepth: 2
@@ -174,7 +175,7 @@ The project is licensed under the terms of the Apache 2.0 license, like
174175
.. _Create an issue: https://github.com/crate/crate-python/issues
175176
.. _Dask: https://en.wikipedia.org/wiki/Dask_(software)
176177
.. _development sandbox: https://github.com/crate/crate-python/blob/master/DEVELOP.rst
177-
.. _cratedb-examples repository: https://github.com/crate/cratedb-examples/tree/main/by-language
178+
.. _cratedb-examples repository: https://github.com/crate/cratedb-examples
178179
.. _FIWARE QuantumLeap data historian: https://github.com/orchestracities/ngsi-timeseries-api
179180
.. _GeoJSON: https://geojson.org/
180181
.. _GeoJSON geometry objects: https://tools.ietf.org/html/rfc7946#section-3.1
@@ -184,6 +185,8 @@ The project is licensed under the terms of the Apache 2.0 license, like
184185
.. _pandas: https://en.wikipedia.org/wiki/Pandas_(software)
185186
.. _PEP 249: https://peps.python.org/pep-0249/
186187
.. _PyPy: https://www.pypy.org/
188+
.. _python-dataframe-examples: https://github.com/crate/cratedb-examples/tree/main/by-dataframe
189+
.. _python-sqlalchemy-examples: https://github.com/crate/cratedb-examples/tree/main/by-language/python-sqlalchemy
187190
.. _sample application: https://github.com/crate/crate-sample-apps/tree/main/python-flask
188191
.. _sample application documentation: https://github.com/crate/crate-sample-apps/blob/main/python-flask/documentation.md
189192
.. _SQLAlchemy: https://en.wikipedia.org/wiki/Sqlalchemy

0 commit comments

Comments
 (0)