Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: Add link to "by-example" section to primary navigation #574

Merged
merged 2 commits into from
Sep 6, 2023
Merged

Documentation: Add link to "by-example" section to primary navigation #574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88d9cd3
Documentation: Add link to "by-example" section to primary navigation
amotl Sep 6, 2023
c68e38c
Documentation: Improve text layout/flow
amotl Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions docs/by-example/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,8 @@
By example
##########


*****
About
*****

This part of the documentation contains examples how to use the CrateDB Python
client.
This part of the documentation enumerates different kinds of examples how to
use the CrateDB Python client.


DB API, HTTP, and BLOB interfaces
Expand Down
14 changes: 11 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,9 @@ Documentation
For general help about the Python Database API, or SQLAlchemy, please consult
`PEP 249`_, the `SQLAlchemy tutorial`_, and the general `SQLAlchemy
documentation`_.

For more detailed information about how to install the client driver, how to
connect to a CrateDB cluster, and how to run queries, consult the resources
referenced below. A dedicated section demonstrates how to use the :ref:`blob
storage capabilities <crate-reference:blob_support>` of CrateDB.
referenced below.

.. toctree::
:titlesonly:
Expand Down Expand Up @@ -160,6 +158,11 @@ The DB API driver and the SQLAlchemy dialect support :ref:`CrateDB's data types
please consult the :ref:`data-types` and :ref:`SQLAlchemy extension types
<using-extension-types>` documentation pages.

.. toctree::
:maxdepth: 2

data-types

Examples
========

Expand All @@ -173,6 +176,11 @@ Examples
connect to CrateDB using `pandas`_, and how to load and export data.
- The `Apache Superset`_ and `FIWARE QuantumLeap data historian`_ projects.

.. toctree::
:maxdepth: 2

by-example/index


*******************
Project information
Expand Down