Skip to content

Commit

Permalink
Include README in kedro-datasets documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>
  • Loading branch information
astrojuanlu committed Nov 10, 2023
1 parent b193b23 commit 38c8c03
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions kedro-datasets/docs/source/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
% Kedro documentation master file, created by
% sphinx-quickstart on Mon Dec 18 11:31:24 2017.
% You can adapt this file completely to your liking, but it should at least
% contain the root `toctree` directive.

# Welcome to kedro-datasets documentation!

kedro-datasets is a plugin that contains a set of official Kedro data connectors,
including CSV, Excel, Parquet, Feather, HDF5, JSON, Pickle, SQL Tables, SQL Queries, Spark DataFrames and more.

These data connectors are supported with the APIs of pandas, spark, networkx, matplotlib, yaml and more.
```{include} ../../README.md
:relative-images:
```

## API documentation

Expand All @@ -22,6 +14,8 @@ These data connectors are supported with the APIs of pandas, spark, networkx, ma
```{rubric} Classes
```

## API documentation

```{eval-rst}
.. autosummary::
:toctree:
Expand Down

0 comments on commit 38c8c03

Please sign in to comment.