.. 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.


.. image:: https://raw.githubusercontent.com/quantumblacklabs/kedro/master/img/kedro_banner.jpg
    :alt: Kedro logo
    :class: kedro-logo

Welcome to Kedro's API docs and tutorials!
=============================================

.. image:: https://circleci.com/gh/quantumblacklabs/kedro/tree/master.svg?style=shield
    :target: https://circleci.com/gh/quantumblacklabs/kedro/tree/master
    :alt: CircleCI build status

.. image:: https://ci.appveyor.com/api/projects/status/2u74p5g8fdc45wwh/branch/master?svg=true
    :target: https://ci.appveyor.com/project/QuantumBlack/kedro/branch/master
    :alt: AppVeyor build status

.. image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg
    :target: https://opensource.org/licenses/Apache-2.0
    :alt: License is Apache 2.0

.. image:: https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7-blue.svg
    :target: https://pypi.org/project/kedro/
    :alt: Python version 3.5, 3.6, 3.7

.. image:: https://badge.fury.io/py/kedro.svg
    :target: https://pypi.org/project/kedro/
    :alt: PyPI package version

.. image:: https://readthedocs.org/projects/kedro/badge/?version=latest
    :target: https://kedro.readthedocs.io/
    :alt: Docs build status

.. image:: https://img.shields.io/badge/code%20style-black-black.svg
    :target: https://github.com/ambv/black
    :alt: Code style is Black

.. image:: https://pepy.tech/badge/kedro
    :target: https://pepy.tech/project/kedro
    :alt: Downloads

.. toctree::
   :maxdepth: 2
   :caption: Introduction

   01_introduction/01_introduction


.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   02_getting_started/01_prerequisites
   02_getting_started/02_install
   02_getting_started/03_new_project
   02_getting_started/04_hello_world


.. toctree::
   :maxdepth: 2
   :caption: Tutorial

   03_tutorial/01_workflow
   03_tutorial/02_tutorial_template
   03_tutorial/03_set_up_data
   03_tutorial/04_create_pipelines
   03_tutorial/05_package_a_project


.. toctree::
   :maxdepth: 2
   :caption: User Guide

   04_user_guide/01_setting_up_vscode
   04_user_guide/02_setting_up_pycharm
   04_user_guide/03_configuration
   04_user_guide/04_data_catalog
   04_user_guide/05_nodes
   04_user_guide/06_pipelines
   04_user_guide/07_logging
   04_user_guide/08_advanced_io
   04_user_guide/09_pyspark
   04_user_guide/10_developing_plugins
   04_user_guide/11_ipython
   04_user_guide/12_working_with_databricks
   04_user_guide/13_journal

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

   06_resources/01_faq
   06_resources/02_architecture_overview
   06_resources/03_commands_reference
   06_resources/04_lint


API Docs
========

.. toctree::
   :maxdepth: 0
   :caption: API Docs
   :hidden:

   kedro

.. autosummary::
   :template: autosummary/module.rst

   kedro

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
