Skip to content

Commit b5b01b3

Browse files
committed
Documentation: Add pointers to executable code examples
1 parent 9032a3f commit b5b01b3

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
@@ -166,6 +166,7 @@ Examples
166166
- The :ref:`by-example` section enumerates concise examples demonstrating the
167167
different API interfaces of the CrateDB Python client library. Those are
168168
DB API, HTTP, and BLOB interfaces, and the SQLAlchemy dialect.
169+
- Executable code examples are maintained within the `cratedb-examples repository`_.
169170
- The `sample application`_ and the corresponding `sample application
170171
documentation`_ demonstrate the use of the driver on behalf of an example
171172
"guestbook" application.
@@ -215,6 +216,7 @@ The project is licensed under the terms of the Apache 2.0 license, like
215216
.. _CrateDB source: https://github.com/crate/crate
216217
.. _Create an issue: https://github.com/crate/crate-python/issues
217218
.. _development sandbox: https://github.com/crate/crate-python/blob/master/DEVELOP.rst
219+
.. _cratedb-examples repository: https://github.com/crate/cratedb-examples/blob/main/by-language
218220
.. _FIWARE QuantumLeap data historian: https://github.com/orchestracities/ngsi-timeseries-api
219221
.. _GeoJSON: https://geojson.org/
220222
.. _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/blob/main/by-language

0 commit comments

Comments
 (0)