Include yaml examples in dataset docs

Description

The most common way I look up the docs for a DataSet is to google search for things like kedro csv, which lands me in the kedro.extras.datasets.pandas.CSVDataSet docs. This is great to see the api, but it is a bit confusing that the suggested catalog method is to use yaml, but the docs are in python.

Search for the docs

Current page

Currently the docs look like this, and do not include good examples for creating real catalog entries with the dataset.

But the suggested way to add datasets to the catalog is with the yaml api, which looks like this.

Context

Aligning the preferred/suggested method of creating catalogs with likely entrypoints into the docs would encourage users to use that method and have less confusion for those who aren’t quite sure of the difference between the python api and yaml api.

Possible Implementation

Include yaml examples in the DataSet docstrings, with backlinks to how to implement the catalog in anyway that is documented. If the python api is left in as an example there should be a link to show how to implement that example into the project.

[noklam]

Closing this since the CSVDataSet example is in place. #1762 will be the new issue to track the progress of enhancing DataSet API Docs

CC @levimjoseph

[yetudada]

I’ve always wondered about this too. I think it would be great to see YAML equivalent examples for the datasets. I’ll create hacktoberfest tickets for this.