Skip to content

Commit fb4d70d

Browse files
authored
Docs simplification (#721)
1 parent d75a4ef commit fb4d70d

File tree

2 files changed

+6
-47
lines changed

2 files changed

+6
-47
lines changed

docs/by-example/index.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@
44
By example
55
##########
66

7-
This part of the documentation enumerates different kinds of examples how to
8-
use the CrateDB Python DBAPI HTTP client for standards-based database
9-
conversations, and the proprietary BLOB interfaces.
10-
117
The examples in this section are all about CrateDB's `Python DB API`_ interface,
128
the plain HTTP API interface, and a convenience interface for working with
139
:ref:`blob tables <crate-reference:blob_support>`. It details attributes,

docs/index.rst

Lines changed: 6 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,11 @@ please consult the :ref:`data-types` documentation page.
8989

9090
data-types
9191

92-
9392
Migration Notes
9493
===============
9594

96-
The :ref:`CrateDB dialect <sqlalchemy-cratedb:index>` for `SQLAlchemy`_ is provided
97-
by the `sqlalchemy-cratedb`_ package.
95+
The :ref:`CrateDB dialect <sqlalchemy-cratedb:index>` for `SQLAlchemy`_ is
96+
provided by the `sqlalchemy-cratedb`_ package.
9897

9998
If you are migrating from previous versions of ``crate[sqlalchemy]<1.0.0``, you
10099
will find that the newer releases ``crate>=1.0.0`` no longer include the
@@ -127,53 +126,17 @@ Examples
127126
by-example/index
128127

129128

130-
*******************
131-
Project information
132-
*******************
133-
134-
Resources
135-
=========
136-
- `Source code <https://github.com/crate/crate-python>`_
137-
- `Documentation <https://crate.io/docs/python/>`_
138-
- `Python Package Index (PyPI) <https://pypi.org/project/crate/>`_
139-
140-
Contributions
141-
=============
142-
The CrateDB Python client library is an open source project, and is `managed on
143-
GitHub`_.
144-
Every kind of contribution, feedback, or patch, is much welcome. `Create an
145-
issue`_ or submit a patch if you think we should include a new feature, or to
146-
report or fix a bug.
147-
148-
Development
149-
===========
150-
In order to setup a development environment on your workstation, please head
151-
over to the `development sandbox`_ documentation. When you see the software
152-
tests succeed, you should be ready to start hacking.
129+
.. seealso::
153130

154-
Page index
155-
==========
156-
The full index for all documentation pages can be inspected at :ref:`index-all`.
157-
158-
License
159-
=======
160-
The project is licensed under the terms of the Apache 2.0 license, like
161-
`CrateDB itself <CrateDB source_>`_, see `LICENSE`_.
131+
The CrateDB Python client library is an open source project and is `managed
132+
on GitHub`_. Contributions, feedback, or patches are highly welcome!
162133

163134

164-
.. _Apache Superset: https://github.com/apache/superset
165-
.. _Crash CLI: https://crate.io/docs/crate/crash/
166135
.. _CrateDB: https://crate.io/products/cratedb
167136
.. _CrateDB Cloud: https://console.cratedb.cloud/
168-
.. _CrateDB source: https://github.com/crate/crate
169-
.. _Create an issue: https://github.com/crate/crate-python/issues
137+
.. _Crash CLI: https://crate.io/docs/crate/crash/
170138
.. _Dask: https://en.wikipedia.org/wiki/Dask_(software)
171-
.. _development sandbox: https://github.com/crate/crate-python/blob/main/DEVELOP.rst
172139
.. _cratedb-examples repository: https://github.com/crate/cratedb-examples
173-
.. _FIWARE QuantumLeap data historian: https://github.com/orchestracities/ngsi-timeseries-api
174-
.. _GeoJSON: https://geojson.org/
175-
.. _GeoJSON geometry objects: https://tools.ietf.org/html/rfc7946#section-3.1
176-
.. _LICENSE: https://github.com/crate/crate-python/blob/main/LICENSE
177140
.. _managed on GitHub: https://github.com/crate/crate-python
178141
.. _migrate to sqlalchemy-cratedb: https://cratedb.com/docs/sqlalchemy-cratedb/migrate-from-crate-client.html
179142
.. _pandas: https://en.wikipedia.org/wiki/Pandas_(software)

0 commit comments

Comments
 (0)