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.

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

docs(datasets): Improve documentation index #428

Merged
merged 1 commit into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 3 additions & 5 deletions kedro-datasets/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion kedro-datasets/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

# -- Project information -----------------------------------------------------

project = "kedro"
project = "kedro-datasets"
author = "kedro"

# The short X.Y version.
Expand Down
22 changes: 22 additions & 0 deletions kedro-datasets/docs/source/index.md
Original file line number Diff line number Diff line change
@@ -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`
22 changes: 0 additions & 22 deletions kedro-datasets/docs/source/index.rst

This file was deleted.