From e6c488f78c8da9ca78cce160edbc8533bbcfe01d Mon Sep 17 00:00:00 2001 From: Tom Close Date: Tue, 7 Jan 2025 14:40:30 +1100 Subject: [PATCH] renamed tutorials to give natural order --- new-docs/source/index.rst | 16 ++++++++-------- ...ing-started.ipynb => 1-getting-started.ipynb} | 0 ...xecution.ipynb => 2-advanced-execution.ipynb} | 2 +- .../tutorial/{python.ipynb => 3-python.ipynb} | 0 .../tutorial/{shell.ipynb => 4-shell.ipynb} | 0 .../{workflow.ipynb => 5-workflow.ipynb} | 0 ...nonical-form.ipynb => 6-canonical-form.ipynb} | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) rename new-docs/source/tutorial/{getting-started.ipynb => 1-getting-started.ipynb} (100%) rename new-docs/source/tutorial/{advanced-execution.ipynb => 2-advanced-execution.ipynb} (99%) rename new-docs/source/tutorial/{python.ipynb => 3-python.ipynb} (100%) rename new-docs/source/tutorial/{shell.ipynb => 4-shell.ipynb} (100%) rename new-docs/source/tutorial/{workflow.ipynb => 5-workflow.ipynb} (100%) rename new-docs/source/tutorial/{canonical-form.ipynb => 6-canonical-form.ipynb} (98%) diff --git a/new-docs/source/index.rst b/new-docs/source/index.rst index 20f2883f3..0831f73f4 100644 --- a/new-docs/source/index.rst +++ b/new-docs/source/index.rst @@ -15,10 +15,10 @@ multiparameter map-reduce operations, in Python code and the use of a global cac Pydra's key features are: -* Combine diverse tasks, implemented in `Python functions <./tutorial/python.html>`__ or stand-alone `shell commands <./tutorial/shell.html>`__, into coherent `workflows <./tutorial/workflow.html>`__ +* Combine diverse tasks, implemented in `Python functions <./tutorial/3-python.html>`__ or stand-alone `shell commands <./tutorial/4-shell.html>`__, into coherent `workflows <./tutorial/5-workflow.html>`__ * Map-reduce like semantics (see :ref:`Splitting and combining`) * Dynamic workflow construction using Python code (see :ref:`Dynamic construction`) -* Modular execution systems for varied deployment on cloud, HPC, etc... (see `Execution options <./tutorial/advanced-execution.html>`__) +* Modular execution systems for varied deployment on cloud, HPC, etc... (see `Execution options <./tutorial/2-advanced-execution.html>`__) * Support for the execution of tasks in containerized environments (see :ref:`Containers and environments`) * Global caching to reduce recomputation (see :ref:`Hashing and caching`) * Support for strong type-checking, including file types, at workflow construction time (see :ref:`Typing and file-formats`) @@ -112,18 +112,18 @@ See the full reference documentation for Pydra :caption: Tutorials: Execution :hidden: - tutorial/getting-started - tutorial/advanced-execution + tutorial/1-getting-started + tutorial/2-advanced-execution .. toctree:: :maxdepth: 2 :caption: Tutorials: Design :hidden: - tutorial/python - tutorial/shell - tutorial/workflow - tutorial/canonical-form + tutorial/3-python + tutorial/4-shell + tutorial/5-workflow + tutorial/6-canonical-form .. toctree:: diff --git a/new-docs/source/tutorial/getting-started.ipynb b/new-docs/source/tutorial/1-getting-started.ipynb similarity index 100% rename from new-docs/source/tutorial/getting-started.ipynb rename to new-docs/source/tutorial/1-getting-started.ipynb diff --git a/new-docs/source/tutorial/advanced-execution.ipynb b/new-docs/source/tutorial/2-advanced-execution.ipynb similarity index 99% rename from new-docs/source/tutorial/advanced-execution.ipynb rename to new-docs/source/tutorial/2-advanced-execution.ipynb index f31e66c6d..ddb473ef3 100644 --- a/new-docs/source/tutorial/advanced-execution.ipynb +++ b/new-docs/source/tutorial/2-advanced-execution.ipynb @@ -43,7 +43,7 @@ "inputs then the location of its output directory will also be the same, and the outputs\n", "generated by the previous run are reused.\n", "\n", - "For example, using the MrGrid example from the [Getting Started Tutorial](./getting-started.html)\n" + "For example, using the MrGrid example from the [Getting Started Tutorial](./1-getting-started.html)\n" ] }, { diff --git a/new-docs/source/tutorial/python.ipynb b/new-docs/source/tutorial/3-python.ipynb similarity index 100% rename from new-docs/source/tutorial/python.ipynb rename to new-docs/source/tutorial/3-python.ipynb diff --git a/new-docs/source/tutorial/shell.ipynb b/new-docs/source/tutorial/4-shell.ipynb similarity index 100% rename from new-docs/source/tutorial/shell.ipynb rename to new-docs/source/tutorial/4-shell.ipynb diff --git a/new-docs/source/tutorial/workflow.ipynb b/new-docs/source/tutorial/5-workflow.ipynb similarity index 100% rename from new-docs/source/tutorial/workflow.ipynb rename to new-docs/source/tutorial/5-workflow.ipynb diff --git a/new-docs/source/tutorial/canonical-form.ipynb b/new-docs/source/tutorial/6-canonical-form.ipynb similarity index 98% rename from new-docs/source/tutorial/canonical-form.ipynb rename to new-docs/source/tutorial/6-canonical-form.ipynb index 4ff8b93ec..4472f4d9c 100644 --- a/new-docs/source/tutorial/canonical-form.ipynb +++ b/new-docs/source/tutorial/6-canonical-form.ipynb @@ -10,7 +10,7 @@ "`pydra.design.*.define` decorators/functions are translated to\n", "[dataclasses](https://docs.python.org/3/library/dataclasses.html) by the\n", "[Attrs](https://www.attrs.org/en/stable/). While the more compact syntax described\n", - "in the [Python-tasks](./python.html), [Shell-tasks](./shell.html) and [Workflow](./workflow.html)\n", + "in the [Python-tasks](./3-python.html), [Shell-tasks](./4-shell.html) and [Workflow](./5-workflow.html)\n", "tutorials is convenient when designing tasks for specific use cases, it is too magical\n", "for linters follow. Therefore, when designing task definitions to be used by third\n", "parties (e.g. `pydra-fsl`, `pydra-ants`) it is recommended to favour the, more\n",