Skip to content

Commit 6f1c8e3

Browse files
committed
restructuring new docs
1 parent 8e88ed2 commit 6f1c8e3

File tree

11 files changed

+100
-45
lines changed

11 files changed

+100
-45
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Conditional construction
2-
========================
1+
Conditionals and lazy fields
2+
============================
33

44
Work in progress...
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Caching
2-
=======
1+
Caching and hashing
2+
===================
33

44
Work in progress....

new-docs/source/howto/create-task-package.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Creating a task package"
7+
"# Create a task package"
88
]
99
},
1010
{

new-docs/source/index.rst

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,35 +27,67 @@ those commands installed on the execution machine, or use software containers
2727
(e.g., Docker or Singularity) to run them.
2828

2929

30+
Tutorials
31+
---------
32+
33+
* :ref:`Getting started`
34+
* :ref:`Execution options`
35+
* :ref:`Python-tasks`
36+
* :ref:`Shell-tasks`
37+
* :ref:`Workflows`
38+
39+
Examples
40+
--------
41+
42+
* :ref:`Real-world example`
43+
44+
How-to Guides
45+
-------------
46+
47+
* :ref:`Create a task package`
48+
* :ref:`Port interfaces from Nipype`
49+
3050
Indices and tables
3151
------------------
3252

3353
* :ref:`genindex`
3454
* :ref:`modindex`
3555

56+
.. toctree::
57+
:maxdepth: 2
58+
:hidden:
59+
60+
tutorial/getting-started
61+
tutorial/advanced-execution
3662

3763
.. toctree::
3864
:maxdepth: 2
39-
:caption: Tutorials
65+
:caption: Design
4066
:hidden:
4167

42-
tutorial/execution
4368
tutorial/python
4469
tutorial/shell
4570
tutorial/workflow
4671

72+
73+
.. toctree::
74+
:maxdepth: 2
75+
:caption: Examples
76+
:hidden:
77+
78+
examples/real-example
79+
4780
.. toctree::
4881
:maxdepth: 2
49-
:caption: How-to Guides
82+
:caption: How-to
5083
:hidden:
5184

52-
howto/real-example
5385
howto/create-task-package
5486
howto/port-from-nipype
5587

5688
.. toctree::
5789
:maxdepth: 2
58-
:caption: Explanation
90+
:caption: In-depth
5991
:hidden:
6092

6193
explanation/design-approach
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# Execution options"
8+
]
9+
},
10+
{
11+
"cell_type": "markdown",
12+
"metadata": {},
13+
"source": [
14+
"## Execution plugins"
15+
]
16+
},
17+
{
18+
"cell_type": "markdown",
19+
"metadata": {},
20+
"source": [
21+
"## Cache locations"
22+
]
23+
},
24+
{
25+
"cell_type": "markdown",
26+
"metadata": {},
27+
"source": [
28+
"## Environments"
29+
]
30+
},
31+
{
32+
"cell_type": "markdown",
33+
"metadata": {},
34+
"source": []
35+
}
36+
],
37+
"metadata": {
38+
"language_info": {
39+
"name": "python"
40+
}
41+
},
42+
"nbformat": 4,
43+
"nbformat_minor": 2
44+
}

new-docs/source/tutorial/execution.ipynb renamed to new-docs/source/tutorial/getting-started.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Running tasks\n",
7+
"# Getting started\n",
88
"\n",
99
"A *Task* is the basic runnable component in Pydra, and can execute either a Python function,\n",
1010
"shell command or workflows consisting of combinations of all three types."

new-docs/source/tutorial/python.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Python-task design"
7+
"# Python-tasks"
88
]
99
},
1010
{

new-docs/source/tutorial/shell.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Shell-task design"
7+
"# Shell-tasks"
88
]
99
},
1010
{

new-docs/source/tutorial/tst.py

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)