Skip to content

Commit 48706f8

Browse files
authored
(chores): clean up nav bar according to the dependencies (#1193)
clean up datasets nav bar Signed-off-by: Nok Lam Chan <[email protected]>
1 parent 2b032e8 commit 48706f8

File tree

2 files changed

+108
-69
lines changed

2 files changed

+108
-69
lines changed

kedro-datasets/RELEASE.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Upcoming Release
2+
## Major features and improvements
3+
4+
- Group datasets documentation according to the dependencies to clean up the nav bar.
25

36
# Release 8.1.0
47
## Major features and improvements
58

69
- Added the following new experimental datasets:
710

811
| Type | Description | Location |
9-
|--------------------------------|---------------------------------------------------------------|--------------------------------------|
12+
| ------------------------------ | ------------------------------------------------------------- | ------------------------------------ |
1013
| `polars.PolarsDatabaseDataset` | A dataset to load and save data to a SQL backend using Polars | `kedro_datasets_experimental.polars` |
1114

1215
## Bug fixes and other changes
@@ -29,7 +32,7 @@
2932
- Added the following new datasets:
3033

3134
| Type | Description | Location |
32-
|-----------------------|-----------------------------------------------------------------------------------|--------------------------|
35+
| --------------------- | --------------------------------------------------------------------------------- | ------------------------ |
3336
| `openxml.DocxDataset` | A dataset for loading and saving .docx files (Microsoft Word) using `python-docx` | `kedro_datasets.openxml` |
3437

3538
## Bug fixes and other changes

kedro-datasets/mkdocs.yml

Lines changed: 103 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -230,72 +230,108 @@ nav:
230230
- API documentation:
231231
- Core Datasets:
232232
- Overview: index.md
233-
- api.APIDataset: api/kedro_datasets/api.APIDataset.md
234-
- biosequence.BioSequenceDataset: api/kedro_datasets/biosequence.BioSequenceDataset.md
235-
- dask.CSVDataset: api/kedro_datasets/dask.CSVDataset.md
236-
- dask.ParquetDataset: api/kedro_datasets/dask.ParquetDataset.md
237-
- databricks.ManagedTableDataset: api/kedro_datasets/databricks.ManagedTableDataset.md
238-
- email.EmailMessageDataset: api/kedro_datasets/email.EmailMessageDataset.md
239-
- geopandas.GenericDataset: api/kedro_datasets/geopandas.GenericDataset.md
240-
- holoviews.HoloviewsWriter: api/kedro_datasets/holoviews.HoloviewsWriter.md
241-
- huggingface.HFDataset: api/kedro_datasets/huggingface.HFDataset.md
242-
- huggingface.HFTransformerPipelineDataset: api/kedro_datasets/huggingface.HFTransformerPipelineDataset.md
243-
- ibis.FileDataset: api/kedro_datasets/ibis.FileDataset.md
244-
- ibis.TableDataset: api/kedro_datasets/ibis.TableDataset.md
245-
- json.JSONDataset: api/kedro_datasets/json.JSONDataset.md
246-
- matlab.MatlabDataset: api/kedro_datasets/matlab.MatlabDataset.md
247-
- matplotlib.MatplotlibDataset: api/kedro_datasets/matplotlib.MatplotlibDataset.md
248-
- matplotlib.MatplotlibWriter: api/kedro_datasets/matplotlib.MatplotlibWriter.md
249-
- networkx.GMLDataset: api/kedro_datasets/networkx.GMLDataset.md
250-
- networkx.GraphMLDataset: api/kedro_datasets/networkx.GraphMLDataset.md
251-
- networkx.JSONDataset: api/kedro_datasets/networkx.JSONDataset.md
252-
- docx.DocxDataset: api/kedro_datasets/openxml.DocxDataset.md
253-
- pandas.CSVDataset: api/kedro_datasets/pandas.CSVDataset.md
254-
- pandas.DeltaTableDataset: api/kedro_datasets/pandas.DeltaTableDataset.md
255-
- pandas.ExcelDataset: api/kedro_datasets/pandas.ExcelDataset.md
256-
- pandas.FeatherDataset: api/kedro_datasets/pandas.FeatherDataset.md
257-
- pandas.GBQQueryDataset: api/kedro_datasets/pandas.GBQQueryDataset.md
258-
- pandas.GBQTableDataset: api/kedro_datasets/pandas.GBQTableDataset.md
259-
- pandas.GenericDataset: api/kedro_datasets/pandas.GenericDataset.md
260-
- pandas.HDFDataset: api/kedro_datasets/pandas.HDFDataset.md
261-
- pandas.JSONDataset: api/kedro_datasets/pandas.JSONDataset.md
262-
- pandas.ParquetDataset: api/kedro_datasets/pandas.ParquetDataset.md
263-
- pandas.SQLQueryDataset: api/kedro_datasets/pandas.SQLQueryDataset.md
264-
- pandas.SQLTableDataset: api/kedro_datasets/pandas.SQLTableDataset.md
265-
- pandas.XMLDataset: api/kedro_datasets/pandas.XMLDataset.md
266-
- partitions.IncrementalDataset: api/kedro_datasets/partitions.IncrementalDataset.md
267-
- partitions.PartitionedDataset: api/kedro_datasets/partitions.PartitionedDataset.md
268-
- pickle.PickleDataset: api/kedro_datasets/pickle.PickleDataset.md
269-
- pillow.ImageDataset: api/kedro_datasets/pillow.ImageDataset.md
270-
- plotly.HTMLDataset: api/kedro_datasets/plotly.HTMLDataset.md
271-
- plotly.JSONDataset: api/kedro_datasets/plotly.JSONDataset.md
272-
- plotly.PlotlyDataset: api/kedro_datasets/plotly.PlotlyDataset.md
273-
- polars.CSVDataset: api/kedro_datasets/polars.CSVDataset.md
274-
- polars.EagerPolarsDataset: api/kedro_datasets/polars.EagerPolarsDataset.md
275-
- polars.LazyPolarsDataset: api/kedro_datasets/polars.LazyPolarsDataset.md
276-
- redis.PickleDataset: api/kedro_datasets/redis.PickleDataset.md
277-
- snowflake.SnowparkTableDataset: api/kedro_datasets/snowflake.SnowparkTableDataset.md
278-
- spark.DeltaTableDataset: api/kedro_datasets/spark.DeltaTableDataset.md
279-
- spark.GBQQueryDataset: api/kedro_datasets/spark.GBQQueryDataset.md
280-
- spark.SparkDataset: api/kedro_datasets/spark.SparkDataset.md
281-
- spark.SparkHiveDataset: api/kedro_datasets/spark.SparkHiveDataset.md
282-
- spark.SparkJDBCDataset: api/kedro_datasets/spark.SparkJDBCDataset.md
283-
- spark.SparkStreamingDataset: api/kedro_datasets/spark.SparkStreamingDataset.md
284-
- svmlight.SVMLightDataset: api/kedro_datasets/svmlight.SVMLightDataset.md
285-
- tensorflow.TensorFlowModelDataset: api/kedro_datasets/tensorflow.TensorFlowModelDataset.md
286-
- text.TextDataset: api/kedro_datasets/text.TextDataset.md
287-
- yaml.YAMLDataset: api/kedro_datasets/yaml.YAMLDataset.md
233+
- API:
234+
- api.APIDataset: api/kedro_datasets/api.APIDataset.md
235+
- Biosequence:
236+
- biosequence.BioSequenceDataset: api/kedro_datasets/biosequence.BioSequenceDataset.md
237+
- Dask:
238+
- dask.CSVDataset: api/kedro_datasets/dask.CSVDataset.md
239+
- dask.ParquetDataset: api/kedro_datasets/dask.ParquetDataset.md
240+
- Databricks:
241+
- databricks.ManagedTableDataset: api/kedro_datasets/databricks.ManagedTableDataset.md
242+
- Email:
243+
- email.EmailMessageDataset: api/kedro_datasets/email.EmailMessageDataset.md
244+
- Geopandas:
245+
- geopandas.GenericDataset: api/kedro_datasets/geopandas.GenericDataset.md
246+
- Holoviews:
247+
- holoviews.HoloviewsWriter: api/kedro_datasets/holoviews.HoloviewsWriter.md
248+
- Huggingface:
249+
- huggingface.HFDataset: api/kedro_datasets/huggingface.HFDataset.md
250+
- huggingface.HFTransformerPipelineDataset: api/kedro_datasets/huggingface.HFTransformerPipelineDataset.md
251+
- Ibis:
252+
- ibis.FileDataset: api/kedro_datasets/ibis.FileDataset.md
253+
- ibis.TableDataset: api/kedro_datasets/ibis.TableDataset.md
254+
- JSON:
255+
- json.JSONDataset: api/kedro_datasets/json.JSONDataset.md
256+
- Matlab:
257+
- matlab.MatlabDataset: api/kedro_datasets/matlab.MatlabDataset.md
258+
- Matplotlib:
259+
- matplotlib.MatplotlibDataset: api/kedro_datasets/matplotlib.MatplotlibDataset.md
260+
- matplotlib.MatplotlibWriter: api/kedro_datasets/matplotlib.MatplotlibWriter.md
261+
- NetworkX:
262+
- networkx.GMLDataset: api/kedro_datasets/networkx.GMLDataset.md
263+
- networkx.GraphMLDataset: api/kedro_datasets/networkx.GraphMLDataset.md
264+
- networkx.JSONDataset: api/kedro_datasets/networkx.JSONDataset.md
265+
- OpenXML:
266+
- docx.DocxDataset: api/kedro_datasets/openxml.DocxDataset.md
267+
- Pandas:
268+
- pandas.CSVDataset: api/kedro_datasets/pandas.CSVDataset.md
269+
- pandas.DeltaTableDataset: api/kedro_datasets/pandas.DeltaTableDataset.md
270+
- pandas.ExcelDataset: api/kedro_datasets/pandas.ExcelDataset.md
271+
- pandas.FeatherDataset: api/kedro_datasets/pandas.FeatherDataset.md
272+
- pandas.GBQQueryDataset: api/kedro_datasets/pandas.GBQQueryDataset.md
273+
- pandas.GBQTableDataset: api/kedro_datasets/pandas.GBQTableDataset.md
274+
- pandas.GenericDataset: api/kedro_datasets/pandas.GenericDataset.md
275+
- pandas.HDFDataset: api/kedro_datasets/pandas.HDFDataset.md
276+
- pandas.JSONDataset: api/kedro_datasets/pandas.JSONDataset.md
277+
- pandas.ParquetDataset: api/kedro_datasets/pandas.ParquetDataset.md
278+
- pandas.SQLQueryDataset: api/kedro_datasets/pandas.SQLQueryDataset.md
279+
- pandas.SQLTableDataset: api/kedro_datasets/pandas.SQLTableDataset.md
280+
- pandas.XMLDataset: api/kedro_datasets/pandas.XMLDataset.md
281+
- Partitions:
282+
- partitions.IncrementalDataset: api/kedro_datasets/partitions.IncrementalDataset.md
283+
- partitions.PartitionedDataset: api/kedro_datasets/partitions.PartitionedDataset.md
284+
- Pickle:
285+
- pickle.PickleDataset: api/kedro_datasets/pickle.PickleDataset.md
286+
- Pillow:
287+
- pillow.ImageDataset: api/kedro_datasets/pillow.ImageDataset.md
288+
- Plotly:
289+
- plotly.HTMLDataset: api/kedro_datasets/plotly.HTMLDataset.md
290+
- plotly.JSONDataset: api/kedro_datasets/plotly.JSONDataset.md
291+
- plotly.PlotlyDataset: api/kedro_datasets/plotly.PlotlyDataset.md
292+
- Polars:
293+
- polars.CSVDataset: api/kedro_datasets/polars.CSVDataset.md
294+
- polars.EagerPolarsDataset: api/kedro_datasets/polars.EagerPolarsDataset.md
295+
- polars.LazyPolarsDataset: api/kedro_datasets/polars.LazyPolarsDataset.md
296+
- Redis:
297+
- redis.PickleDataset: api/kedro_datasets/redis.PickleDataset.md
298+
- Snowflake:
299+
- snowflake.SnowparkTableDataset: api/kedro_datasets/snowflake.SnowparkTableDataset.md
300+
- Spark:
301+
- spark.DeltaTableDataset: api/kedro_datasets/spark.DeltaTableDataset.md
302+
- spark.GBQQueryDataset: api/kedro_datasets/spark.GBQQueryDataset.md
303+
- spark.SparkDataset: api/kedro_datasets/spark.SparkDataset.md
304+
- spark.SparkHiveDataset: api/kedro_datasets/spark.SparkHiveDataset.md
305+
- spark.SparkJDBCDataset: api/kedro_datasets/spark.SparkJDBCDataset.md
306+
- spark.SparkStreamingDataset: api/kedro_datasets/spark.SparkStreamingDataset.md
307+
- SVMLight:
308+
- svmlight.SVMLightDataset: api/kedro_datasets/svmlight.SVMLightDataset.md
309+
- TensorFlow:
310+
- tensorflow.TensorFlowModelDataset: api/kedro_datasets/tensorflow.TensorFlowModelDataset.md
311+
- Text:
312+
- text.TextDataset: api/kedro_datasets/text.TextDataset.md
313+
- YAML:
314+
- yaml.YAMLDataset: api/kedro_datasets/yaml.YAMLDataset.md
288315
- Experimental Datasets:
289316
- Overview: api/kedro_datasets_experimental/index.md
290-
- databricks.ExternalTableDataset: api/kedro_datasets_experimental/databricks.ExternalTableDataset.md
291-
- langchain.ChatAnthropicDataset: api/kedro_datasets_experimental/langchain.ChatAnthropicDataset.md
292-
- langchain.ChatCohereDataset: api/kedro_datasets_experimental/langchain.ChatCohereDataset.md
293-
- langchain.ChatOpenAIDataset: api/kedro_datasets_experimental/langchain.ChatOpenAIDataset.md
294-
- langchain.OpenAIEmbeddingsDataset: api/kedro_datasets_experimental/langchain.OpenAIEmbeddingsDataset.md
295-
- netcdf.NetCDFDataset: api/kedro_datasets_experimental/netcdf.NetCDFDataset.md
296-
- polars.PolarsDatabaseDataset: api/kedro_datasets_experimental/polars.PolarsDatabaseDataset.md
297-
- prophet.ProphetModelDataset: api/kedro_datasets_experimental/prophet.ProphetModelDataset.md
298-
- pytorch.PyTorchDataset: api/kedro_datasets_experimental/pytorch.PyTorchDataset.md
299-
- rioxarray.GeoTIFFDataset: api/kedro_datasets_experimental/rioxarray.GeoTIFFDataset.md
300-
- safetensors.SafetensorsDataset: api/kedro_datasets_experimental/safetensors.SafetensorsDataset.md
301-
- video.VideoDataset: api/kedro_datasets_experimental/video.VideoDataset.md
317+
- Databricks:
318+
- databricks.ExternalTableDataset: api/kedro_datasets_experimental/databricks.ExternalTableDataset.md
319+
- Langchain:
320+
- langchain.ChatAnthropicDataset: api/kedro_datasets_experimental/langchain.ChatAnthropicDataset.md
321+
- langchain.ChatCohereDataset: api/kedro_datasets_experimental/langchain.ChatCohereDataset.md
322+
- langchain.ChatOpenAIDataset: api/kedro_datasets_experimental/langchain.ChatOpenAIDataset.md
323+
- langchain.OpenAIEmbeddingsDataset: api/kedro_datasets_experimental/langchain.OpenAIEmbeddingsDataset.md
324+
- NetCDF:
325+
- netcdf.NetCDFDataset: api/kedro_datasets_experimental/netcdf.NetCDFDataset.md
326+
- Polars:
327+
- polars.PolarsDatabaseDataset: api/kedro_datasets_experimental/polars.PolarsDatabaseDataset.md
328+
- Prophet:
329+
- prophet.ProphetModelDataset: api/kedro_datasets_experimental/prophet.ProphetModelDataset.md
330+
- PyTorch:
331+
- pytorch.PyTorchDataset: api/kedro_datasets_experimental/pytorch.PyTorchDataset.md
332+
- RioXarray:
333+
- rioxarray.GeoTIFFDataset: api/kedro_datasets_experimental/rioxarray.GeoTIFFDataset.md
334+
- Safetensors:
335+
- safetensors.SafetensorsDataset: api/kedro_datasets_experimental/safetensors.SafetensorsDataset.md
336+
- Video:
337+
- video.VideoDataset: api/kedro_datasets_experimental/video.VideoDataset.md

0 commit comments

Comments
 (0)