From b8f3829365b3b3cc4e35107167f2d257dcd7b08d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Juan=20Luis=20Cano=20Rodr=C3=ADguez?=
 <juan_luis_cano@mckinsey.com>
Date: Mon, 11 Dec 2023 13:49:08 +0100
Subject: [PATCH] docs(datasets): Improve documentation index (#428)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Rework documentation index

Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
---
 kedro-datasets/README.md                      |  8 +++----
 .../docs/source/{ => api}/kedro_datasets.rst  |  0
 kedro-datasets/docs/source/conf.py            |  2 +-
 kedro-datasets/docs/source/index.md           | 22 +++++++++++++++++++
 kedro-datasets/docs/source/index.rst          | 22 -------------------
 5 files changed, 26 insertions(+), 28 deletions(-)
 rename kedro-datasets/docs/source/{ => api}/kedro_datasets.rst (100%)
 create mode 100644 kedro-datasets/docs/source/index.md
 delete mode 100644 kedro-datasets/docs/source/index.rst

diff --git a/kedro-datasets/README.md b/kedro-datasets/README.md
index 8309dbcce..daf9a7d1a 100644
--- 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/kedro-datasets/docs/source/kedro_datasets.rst b/kedro-datasets/docs/source/api/kedro_datasets.rst
similarity index 100%
rename from kedro-datasets/docs/source/kedro_datasets.rst
rename to kedro-datasets/docs/source/api/kedro_datasets.rst
diff --git a/kedro-datasets/docs/source/conf.py b/kedro-datasets/docs/source/conf.py
index 87d7475ef..ce919e80b 100644
--- 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
new file mode 100644
index 000000000..90031ffbd
--- /dev/null
+++ 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
deleted file mode 100644
index 84decee2a..000000000
--- a/kedro-datasets/docs/source/index.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-.. 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.
-
-
-API documentation
-=================
-
-.. autosummary::
-   :toctree:
-   :caption: API documentation
-   :template: autosummary/module.rst
-   :recursive:
-
-   kedro_datasets
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`