Skip to content

Commit

Permalink
Collapse the docs ToC to reduce scrolling (#2480)
Browse files Browse the repository at this point in the history
  • Loading branch information
stichbury authored Apr 14, 2023
1 parent 437f68f commit e7315a8
Show file tree
Hide file tree
Showing 28 changed files with 264 additions and 163 deletions.
5 changes: 5 additions & 0 deletions docs/source/_static/css/qb1-sphinx-rtd.css
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,10 @@ body.wy-body-for-nav {
background: none !important;
}

.wy-menu-vertical li.toctree-l1>a {
font-size: 1.8rem;
}

.rst-content.style-external-links a.reference.external:after {
color: inherit;
opacity: 0.8;
Expand Down Expand Up @@ -259,6 +263,7 @@ body.wy-body-for-nav {

.wy-body-for-nav .wy-menu-vertical li.current a:hover {
background: none;
font-weight: 600;
}

.wy-menu-vertical a span.toctree-expand {
Expand Down
10 changes: 10 additions & 0 deletions docs/source/configuration/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Configuration

```{toctree}
:maxdepth: 1
configuration_basics
credentials
parameters
advanced_configuration
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Introduction
# Contribute to Kedro

We welcome any and all contributions to Kedro, at whatever level you can manage. For example, you could:

Expand All @@ -10,3 +10,14 @@ We welcome any and all contributions to Kedro, at whatever level you can manage.
- [Review other contributors' PRs](https://github.com/kedro-org/kedro/pulls)
- [Contribute code](./developer_contributor_guidelines.md), for example to fix a bug or add a feature
- [Contribute to the documentation](documentation_contributor_guidelines.md)


```{toctree}
:hidden:
developer_contributor_guidelines
backwards_compatibility
documentation_contributor_guidelines
technical_steering_committee
development_for_databricks
```
8 changes: 8 additions & 0 deletions docs/source/data/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Data Catalog

```{toctree}
:maxdepth: 1
data_catalog
kedro_io
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Deployment guide
# Deployment

## Deployment choices

Expand Down Expand Up @@ -33,3 +33,20 @@ flowchart TD
H["Does (part of) your pipeline integrate with Amazon SageMaker?<br/><br/>Read the SageMaker integration guide"];
style H text-align:left
```

## Deployment guides

```{toctree}
:maxdepth: 1
single_machine
distributed
argo
prefect
kubeflow
aws_batch
aws_sagemaker
aws_step_functions
airflow_astronomer
dask
```
12 changes: 12 additions & 0 deletions docs/source/development/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Development

```{toctree}
:maxdepth: 1
set_up_vscode
set_up_pycharm
commands_reference
debugging
automated_testing
linting
```
9 changes: 9 additions & 0 deletions docs/source/extend_kedro/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Extend Kedro

```{toctree}
:maxdepth: 1
common_use_cases
custom_datasets
plugins
```
11 changes: 11 additions & 0 deletions docs/source/get_started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# First steps

This section explains the first steps to set up and explore Kedro:

```{toctree}
:maxdepth: 1
install
new_project
kedro_concepts
```
17 changes: 8 additions & 9 deletions docs/source/get_started/install.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# Set up Kedro

## Summary

* Kedro can be used on Windows, macOS or Linux.
* Installation prerequisites include a virtual environment manager like `conda`, Python 3.7+, and `git`.
* You should install Kedro using `pip install kedro`.

If you encounter any problems as you set up Kedro, ask for help on Kedro's [Slack organisation](https://slack.kedro.org) or review the [searchable archive of Slack discussions](https://www.linen.dev/s/kedro).


## Installation prerequisites
* **Python**: Kedro supports macOS, Linux, and Windows and is built for Python 3.7+. You'll select a version of Python when you create a virtual environment for your Kedro project.

Expand Down Expand Up @@ -189,3 +180,11 @@ If you want to roll back to a stable version of Kedro, execute the following in
pip uninstall kedro -y
pip install kedro
```

## Summary

* Kedro can be used on Windows, macOS or Linux.
* Installation prerequisites include a virtual environment manager like `conda`, Python 3.7+, and `git`.
* You should install Kedro using `pip install kedro`.

If you encounter any problems as you set up Kedro, ask for help on Kedro's [Slack organisation](https://slack.kedro.org) or review the [searchable archive of Slack discussions](https://www.linen.dev/s/kedro).
18 changes: 18 additions & 0 deletions docs/source/hooks/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Hooks


## Introduction

Hooks are a mechanism to add extra behaviour to Kedro's main execution in an easy and consistent manner. Some examples might include:

* Adding a log statement after the data catalog is loaded.
* Adding data validation to the inputs before a node runs, and to the outputs after a node has run. This makes it possible to integrate with other tools like [Great-Expectations](https://docs.greatexpectations.io/en/latest/).
* Adding machine learning metrics tracking, e.g. using [MLflow](https://mlflow.org/), throughout a pipeline run.

```{toctree}
:maxdepth: 1
introduction
common_use_cases
examples
```
8 changes: 0 additions & 8 deletions docs/source/hooks/introduction.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Hooks

## Introduction

Hooks are a mechanism to add extra behaviour to Kedro's main execution in an easy and consistent manner. Some examples might include:

* Adding a log statement after the data catalog is loaded
* Adding data validation to the inputs before a node runs, and to the outputs after a node has run. This makes it possible to integrate with other tools like [Great-Expectations](https://docs.greatexpectations.io/en/latest/)
* Adding machine learning metrics tracking, e.g. using [MLflow](https://mlflow.org/), throughout a pipeline run

## Concepts

A Hook consists of a Hook specification, and Hook implementation. To add Hooks to your project, you must:
Expand Down
109 changes: 21 additions & 88 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,157 +53,90 @@ Welcome to Kedro's documentation!

.. toctree::
:maxdepth: 2
:caption: Introduction
:caption: Learn about Kedro

introduction/introduction
introduction/index.md

.. toctree::
:maxdepth: 2
:caption: First steps

get_started/install
get_started/new_project
get_started/kedro_concepts
get_started/index.md

.. toctree::
:maxdepth: 2
:caption: Next steps: Tutorial
:caption: Tutorial and basic Kedro usage

tutorial/spaceflights_tutorial
tutorial/tutorial_template
tutorial/set_up_data
tutorial/create_a_pipeline
tutorial/add_another_pipeline
tutorial/package_a_project
tutorial/spaceflights_tutorial_faqs
tutorial/spaceflights_tutorial.md

.. toctree::
:maxdepth: 2
:caption: Visualisation with Kedro-Viz

visualisation/kedro-viz_visualisation
visualisation/visualise_charts_with_plotly
visualisation/experiment_tracking
visualisation/index.md

.. toctree::
:maxdepth: 2
:caption: Notebooks & IPython users

notebooks_and_ipython/kedro_and_notebooks
notebooks_and_ipython/kedro_as_a_data_registry
notebooks_and_ipython/index.md
resources/index.md

.. toctree::
:maxdepth: 2
:caption: Kedro project setup
:caption: Kedro projects

kedro_project_setup/starters
kedro_project_setup/dependencies
kedro_project_setup/session
kedro_project_setup/settings
kedro_project_setup/index.md

.. toctree::
:maxdepth: 2
:caption: Configuration

configuration/configuration_basics
configuration/credentials
configuration/parameters
configuration/advanced_configuration
configuration/index.md

.. toctree::
:maxdepth: 2
:caption: Data Catalog

data/data_catalog
data/kedro_io
data/index.md

.. toctree::
:maxdepth: 2
:caption: Nodes and pipelines

nodes_and_pipelines/nodes
nodes_and_pipelines/pipeline_introduction
nodes_and_pipelines/modular_pipelines
nodes_and_pipelines/pipeline_registry
nodes_and_pipelines/micro_packaging
nodes_and_pipelines/run_a_pipeline
nodes_and_pipelines/slice_a_pipeline
nodes_and_pipelines/index.md

.. toctree::
:maxdepth: 2
:caption: Extend Kedro
:caption: Advanced usage

extend_kedro/common_use_cases
extend_kedro/custom_datasets
extend_kedro/plugins
extend_kedro/index.md

.. toctree::
:maxdepth: 2
:caption: Hooks

hooks/introduction
hooks/common_use_cases
hooks/examples
hooks/index.md


.. toctree::
:maxdepth: 2
:caption: Logging

logging/logging
logging/index.md

.. toctree::
:maxdepth: 2
:caption: Integrations

integrations/databricks.rst
integrations/pyspark.rst
integrations/index.md

.. toctree::
:maxdepth: 2
:caption: Development

development/set_up_vscode
development/set_up_pycharm
development/commands_reference
development/debugging
development/automated_testing
development/linting
development/index.md

.. toctree::
:maxdepth: 2
:caption: Deployment

deployment/deployment_guide
deployment/single_machine
deployment/distributed
deployment/argo
deployment/prefect
deployment/kubeflow
deployment/aws_batch
deployment/aws_sagemaker
deployment/aws_step_functions
deployment/airflow_astronomer
deployment/dask

.. toctree::
:maxdepth: 2
:caption: Resources

faq/faq
resources/glossary

deployment/index.md

.. toctree::
:maxdepth: 2
:caption: Contribute to Kedro

contribution/contribute_to_kedro
contribution/developer_contributor_guidelines
contribution/backwards_compatibility
contribution/documentation_contributor_guidelines
contribution/technical_steering_committee
contribution/development_for_databricks
contribution/index.md

API documentation
=================
Expand Down
9 changes: 0 additions & 9 deletions docs/source/integrations/databricks.md

This file was deleted.

20 changes: 20 additions & 0 deletions docs/source/integrations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Integrations


## Databricks integration

```{toctree}
:maxdepth: 1
databricks_workspace.md
databricks_visualisation.md
```


## PySpark integration

```{toctree}
:maxdepth: 1
pyspark_integration.md
```
Loading

0 comments on commit e7315a8

Please sign in to comment.