Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

Commit e367da4

Browse files
committed
Docs: Remove docs from readthedocs, only leave Python API
1 parent 2e36969 commit e367da4

File tree

1 file changed

+8
-44
lines changed

1 file changed

+8
-44
lines changed

docs/index.rst

Lines changed: 8 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11
.. toctree::
22
:maxdepth: 2
3-
:caption: Reference
3+
:caption: API Reference
44
:hidden:
55

6-
supported-databases
7-
how-to-use
86
python-api
9-
technical-explanation
10-
new-database-driver-guide
117

12-
Introduction
13-
------------
8+
data-diff
9+
---------
1410

1511
**Data-diff** is a command-line tool and Python library to efficiently diff
1612
rows across two different databases.
@@ -27,45 +23,13 @@ rows across two different databases.
2723

2824
For more information, `See our README <https://github.com/datafold/data-diff#readme>`_
2925

30-
How to install
31-
--------------
32-
33-
Requires Python 3.7+ with pip.
34-
35-
::
36-
37-
pip install data-diff
38-
39-
For installing with 3rd-party database connectors, use the following syntax:
40-
41-
::
42-
43-
pip install "data-diff[db1,db2]"
44-
45-
e.g.
46-
pip install "data-diff[mysql,postgresql]"
47-
48-
Supported connectors:
49-
50-
- mysql
51-
- postgresql
52-
- snowflake
53-
- presto
54-
- oracle
55-
- trino
56-
- clickhouse
57-
- vertica
58-
5926

6027

6128
Resources
6229
---------
6330

64-
- Users
65-
- Source code (git): `<https://github.com/datafold/data-diff>`_
66-
- :doc:`supported-databases`
67-
- :doc:`how-to-use`
68-
- :doc:`python-api`
69-
- :doc:`technical-explanation`
70-
- Contributors
71-
- :doc:`new-database-driver-guide`
31+
- Source code (git): `<https://github.com/datafold/data-diff>`_
32+
- :doc:`python-api`
33+
- The rest of the `documentation`_
34+
35+
.. _documentation: https://docs.datafold.com/os_diff/about/

0 commit comments

Comments
 (0)