Skip to content

Commit d1d1c1a

Browse files
committed
Documentation: Add pointers to executable code examples
1 parent 984c26e commit d1d1c1a

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ Examples
169169
- The :ref:`by-example` section enumerates concise examples demonstrating the
170170
different API interfaces of the CrateDB Python client library. Those are
171171
DB API, HTTP, and BLOB interfaces, and the SQLAlchemy dialect.
172+
- Executable code examples are maintained within the `cratedb-examples repository`_.
172173
- The `sample application`_ and the corresponding `sample application
173174
documentation`_ demonstrate the use of the driver on behalf of an example
174175
"guestbook" application.
@@ -223,6 +224,7 @@ The project is licensed under the terms of the Apache 2.0 license, like
223224
.. _CrateDB source: https://github.com/crate/crate
224225
.. _Create an issue: https://github.com/crate/crate-python/issues
225226
.. _development sandbox: https://github.com/crate/crate-python/blob/master/DEVELOP.rst
227+
.. _cratedb-examples repository: https://github.com/crate/cratedb-examples/tree/main/by-language
226228
.. _FIWARE QuantumLeap data historian: https://github.com/orchestracities/ngsi-timeseries-api
227229
.. _GeoJSON: https://geojson.org/
228230
.. _GeoJSON geometry objects: https://tools.ietf.org/html/rfc7946#section-3.1

examples/README.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
##############################
2+
CrateDB Python driver examples
3+
##############################
4+
5+
6+
Executable code examples are maintained within the `cratedb-examples repository`_.
7+
8+
9+
.. _cratedb-examples repository: https://github.com/crate/cratedb-examples/tree/main/by-language

0 commit comments

Comments
 (0)