pestifer.sphinxext.task_table module¶

Sphinx directive task-table that reads a pestifer YAML config file and renders a compact pipeline-summary table in the documentation.

Consecutive md tasks are collapsed into a single row showing the ensemble sequence and total step counts, keeping the table concise even for workflows with many equilibration phases.

Usage in rst:

.. task-table:: ../../../../pestifer/resources/examples/ex01/inputs/bpti1.yaml

The path is resolved relative to the rst source file (same convention as .. literalinclude::).

class pestifer.sphinxext.task_table.TaskTableDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶

Bases: SphinxDirective

Renders a pipeline-summary table from a pestifer YAML config file.

has_content = False¶: May the directive have content?

optional_arguments = 0¶: Number of optional arguments after the required arguments.

required_arguments = 1¶: Number of required directive arguments.

run()[source]¶