Skip to content

Commit 93cb208

Browse files
tobiasraabetobiasraabe
committed
docs: complete zensical migration and rendering fixes
1 parent ad71d77 commit 93cb208

99 files changed

Lines changed: 1541 additions & 901 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/source/_static/md/commands/build-arguments.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
| Argument | Description |
2+
| ------------ | ---------------------------------------------------------- |
3+
| `[PATHS]...` | Paths where pytask looks for task files and configuration. |

‎docs/source/_static/md/commands/build-options.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
| Option | Default | Description |
2+
| ---------------------------------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
3+
| `-c, --config FILE` | - | Path to configuration file. |
4+
| \`--capture \[fd | no | sys |
5+
| `--database-url TEXT` | - | Url to the database. |
6+
| `--debug-pytask` | `false` | Trace all function calls in the plugin framework. |
7+
| `--disable-warnings` | `false` | Disables the summary for warnings. |
8+
| `--dry-run` | `false` | Perform a dry-run. |
9+
| `--editor-url-scheme TEXT` | `file` | Use file, vscode, pycharm or a custom url scheme to add URLs to task ids to quickly jump to the task definition. Use no_link to disable URLs. |
10+
| `--explain` | `false` | Explain why tasks need to be executed by showing what changed. |
11+
| `-f, --force` | `false` | Execute a task even if it succeeded successfully before. |
12+
| `--hook-module TEXT` | - | Path to a Python module that contains hook implementations. |
13+
| `--ignore TEXT` | - | A pattern to ignore files or directories. Refer to 'pathlib.Path.match' for more info. |
14+
| `-k EXPRESSION` | - | Select tasks via expressions on task ids. |
15+
| `-m MARKER_EXPRESSION` | - | Select tasks via marker expressions. |
16+
| `--max-failures FLOAT RANGE` | `inf` | Stop after some failures. |
17+
| `--n-entries-in-table INTEGER RANGE` | `15` | How many entries to display in the table during the execution. Tasks which are running are always displayed. |
18+
| `--pdb` | `false` | Start the interactive debugger on errors. |
19+
| `--pdbcls module_name:class_name` | - | Start a custom debugger on errors. For example: --pdbcls=IPython.terminal.debugger:TerminalPdb |
20+
| `-s` | `false` | Shortcut for --capture=no. |
21+
| \`--show-capture \[no | stdout | stderr |
22+
| `--show-errors-immediately` | `false` | Show errors with tracebacks as soon as the task fails. |
23+
| `--show-locals` | `false` | Show local variables in tracebacks. |
24+
| `--show-traceback / --show-no-traceback` | `--show-traceback` | Choose whether tracebacks should be displayed or not. |
25+
| `--sort-table / --do-not-sort-table` | `--sort-table` | Sort the table of tasks at the end of the execution. |
26+
| `--strict-markers` | `false` | Raise errors for unknown markers. |
27+
| `--trace` | `false` | Enter debugger in the beginning of each task. |
28+
| `-v, --verbose INTEGER RANGE` | `1` | Make pytask verbose (>= 0) or quiet (= 0). |
29+
| `-x, --stop-after-first-failure` | `false` | Stop after the first failure. |
30+
| `-h, --help` | - | Show this message and exit. |

‎docs/source/_static/md/commands/clean-arguments.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
| Argument | Description |
2+
| ------------ | ---------------------------------------------------------- |
3+
| `[PATHS]...` | Paths where pytask looks for task files and configuration. |

‎docs/source/_static/md/commands/clean-options.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
| Option | Default | Description |
2+
| -------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
3+
| `-c, --config FILE` | - | Path to configuration file. |
4+
| `-d, --directories` | `false` | Remove whole directories. |
5+
| `--database-url TEXT` | - | Url to the database. |
6+
| `-e, --exclude PATTERN` | - | A filename pattern to exclude files from the cleaning process. |
7+
| `--editor-url-scheme TEXT` | `file` | Use file, vscode, pycharm or a custom url scheme to add URLs to task ids to quickly jump to the task definition. Use no_link to disable URLs. |
8+
| `--hook-module TEXT` | - | Path to a Python module that contains hook implementations. |
9+
| `--ignore TEXT` | - | A pattern to ignore files or directories. Refer to 'pathlib.Path.match' for more info. |
10+
| `-k EXPRESSION` | - | Select tasks via expressions on task ids. |
11+
| `-m MARKER_EXPRESSION` | - | Select tasks via marker expressions. |
12+
| \`--mode \[dry-run | force | interactive\]\` |
13+
| `-q, --quiet` | `false` | Do not print the names of the removed paths. |
14+
| `--strict-markers` | `false` | Raise errors for unknown markers. |
15+
| `-h, --help` | - | Show this message and exit. |

‎docs/source/_static/md/commands/collect-arguments.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
| Argument | Description |
2+
| ------------ | ---------------------------------------------------------- |
3+
| `[PATHS]...` | Paths where pytask looks for task files and configuration. |

‎docs/source/_static/md/commands/collect-options.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
| Option | Default | Description |
2+
| -------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
3+
| `-c, --config FILE` | - | Path to configuration file. |
4+
| `--database-url TEXT` | - | Url to the database. |
5+
| `--editor-url-scheme TEXT` | `file` | Use file, vscode, pycharm or a custom url scheme to add URLs to task ids to quickly jump to the task definition. Use no_link to disable URLs. |
6+
| `--hook-module TEXT` | - | Path to a Python module that contains hook implementations. |
7+
| `--ignore TEXT` | - | A pattern to ignore files or directories. Refer to 'pathlib.Path.match' for more info. |
8+
| `-k EXPRESSION` | - | Select tasks via expressions on task ids. |
9+
| `-m MARKER_EXPRESSION` | - | Select tasks via marker expressions. |
10+
| `--nodes` | `false` | Show a task's dependencies and products. |
11+
| `--strict-markers` | `false` | Raise errors for unknown markers. |
12+
| `-h, --help` | - | Show this message and exit. |

‎docs/source/_static/md/commands/command-list.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
| Command | Description |
2+
| ----------------------------------------- | ------------------------------------------------------------- |
3+
| [`build`](../../../commands/build.md) | Collect tasks, execute them and report the results. |
4+
| [`clean`](../../../commands/clean.md) | Clean the provided paths by removing files unknown to pytask. |
5+
| [`collect`](../../../commands/collect.md) | Collect tasks and report information about them. |
6+
| [`dag`](../../../commands/dag.md) | Create a visualization of the directed acyclic graph. |
7+
| [`markers`](../../../commands/markers.md) | Show all registered markers. |
8+
| [`profile`](../../../commands/profile.md) | Show information about resource consumption. |

‎docs/source/_static/md/commands/dag-arguments.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
| Argument | Description |
2+
| ------------ | ---------------------------------------------------------- |
3+
| `[PATHS]...` | Paths where pytask looks for task files and configuration. |

‎docs/source/_static/md/commands/dag-options.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
| Option | Default | Description |
2+
| --------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
3+
| `-c, --config FILE` | - | Path to configuration file. |
4+
| `--database-url TEXT` | - | Url to the database. |
5+
| `--hook-module TEXT` | - | Path to a Python module that contains hook implementations. |
6+
| `-l, --layout TEXT` | `dot` | The layout determines the structure of the graph. Here you find an overview of all available layouts: https://graphviz.org/docs/layouts. |
7+
| `-o, --output-path FILE` | `dag.pdf` | The output path of the visualization. The format is inferred from the file extension. |
8+
| \`-r, --rank-direction \[TB | LR | BT |
9+
| `-h, --help` | - | Show this message and exit. |

‎docs/source/_static/md/commands/markers-arguments.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
| Argument | Description |
2+
| ------------ | ---------------------------------------------------------- |
3+
| `[PATHS]...` | Paths where pytask looks for task files and configuration. |

0 commit comments

Comments
 (0)