docs(datasets): Improve documentation index (kedro-org#428)

Rework documentation index Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> Signed-off-by: tgoelles <[email protected]>
tgoelles · Jun 6, 2024 · 3c0788f · 3c0788f
1 parent 3591ec2
commit 3c0788f
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 28 deletions.
diff --git a/kedro-datasets/README.md b/kedro-datasets/README.md
@@ -1,11 +1,13 @@
 # Kedro-Datasets
 
+<!-- Note that the contents of this file are also used in the documentation, see docs/source/index.md -->
+
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue.svg)](https://pypi.org/project/kedro-datasets/)
 [![PyPI Version](https://badge.fury.io/py/kedro-datasets.svg)](https://pypi.org/project/kedro-datasets/)
 [![Code Style: Black](https://img.shields.io/badge/code%20style-black-black.svg)](https://github.com/ambv/black)
 
-A Kedro plugin that powers Kedro's DataCatalog.
+Welcome to `kedro_datasets`, the home of Kedro's data connectors. Here you will find `AbstractDataset` implementations powering Kedro's DataCatalog created by QuantumBlack and external contributors.
 
 ## Installation
 
@@ -15,10 +17,6 @@ A Kedro plugin that powers Kedro's DataCatalog.
 pip install kedro-datasets
 ```
 
-# Datasets
-
-Welcome to `kedro_datasets`, the home of Kedro's data connectors. Here you will find `AbstractDataset` implementations created by QuantumBlack and external contributors.
-
 ## What `AbstractDataset` implementations are supported?
 
 We support a range of data connectors, including CSV, Excel, Parquet, Feather, HDF5, JSON, Pickle, SQL Tables, SQL Queries, Spark DataFrames and more. We even allow support for working with images.

diff --git a/...o-datasets/docs/source/kedro_datasets.rst → ...tasets/docs/source/api/kedro_datasets.rst b/...o-datasets/docs/source/kedro_datasets.rst → ...tasets/docs/source/api/kedro_datasets.rst
diff --git a/kedro-datasets/docs/source/conf.py b/kedro-datasets/docs/source/conf.py
@@ -25,7 +25,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "kedro"
+project = "kedro-datasets"
 author = "kedro"
 
 # The short X.Y version.

diff --git a/kedro-datasets/docs/source/index.md b/kedro-datasets/docs/source/index.md
@@ -0,0 +1,22 @@
+```{include} ../../README.md
+:relative-images:
+```
+
+# API Documentation
+
+Browse the complete list of datasets:
+
+```{eval-rst}
+.. autosummary::
+   :toctree: api
+   :caption: API documentation
+   :template: autosummary/module.rst
+   :recursive:
+
+   kedro_datasets
+```
+
+# Indices and tables
+
+- {ref}`genindex`
+- {ref}`modindex`
diff --git a/kedro-datasets/docs/source/index.rst b/kedro-datasets/docs/source/index.rst