Commit 38680b0f authored by Michiel Cottaar's avatar Michiel Cottaar
Browse files

Point to FileTree class docstring

parent f2adb61a
......@@ -7,8 +7,10 @@ FileTree tutorial
Introduction
------------
Define input/output paths of a data processing pipeline in an easy-to-use format.
This tutorial shows the many features of filetree through simple pipeline examples.
For an overview of the main API see the :class:`FileTree docstring <file_tree.file_tree.FileTree>`.
The goal here is to define the directory structure for your input/output files separate from the actual pipeline code.
The goal of filetree is to define the directory structure for your input/output files separate from the actual pipeline code.
The directory structure will be defined in a tree file (typically using ".tree" extension) using a format like:
::
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment