.. Custom template for our custom_autosummary. The purpose of using custom_autosummary is list the entries on the right side bar instead of the left side bar. This is achieved with the combination of custom directive, template and CSS. The `custom_autosummary` directive functions mostly like `autosummary`. We pass `:toctree:` option to generate a doc page for each entry, but we use our custom `:hide_from_toctree:` option so as not to attach them in ToC tree. This template inserts a section header for each entry, so that they show up in the right-side bar. The headers are hidden by CSS. Because each entry will have its own table and their borders no longer match, table borders are hidden by CSS and instead we use horizontal line. .. raw:: html
spdl.pipeline.defs ================== Overview -------- .. automodule:: spdl.pipeline.defs API Reference ------------- .. ############################################################################ Functions ############################################################################ .. rubric:: Functions Aggregate ^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: Aggregate Disaggregate ^^^^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: Disaggregate Merge ^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: Merge Pipe ^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: Pipe .. ############################################################################ Attributes ############################################################################ .. ############################################################################ Classes ############################################################################ .. rubric:: Classes Aggregator ^^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: :template: _custom_autosummary_class.rst Aggregator AggregateConfig ^^^^^^^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: :template: _custom_autosummary_class.rst AggregateConfig Collate ^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: :template: _custom_autosummary_class.rst Collate DisaggregateConfig ^^^^^^^^^^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: :template: _custom_autosummary_class.rst DisaggregateConfig MergeConfig ^^^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: :template: _custom_autosummary_class.rst MergeConfig PipeConfig ^^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: :template: _custom_autosummary_class.rst PipeConfig PipelineConfig ^^^^^^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: :template: _custom_autosummary_class.rst PipelineConfig SinkConfig ^^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: :template: _custom_autosummary_class.rst SinkConfig SourceConfig ^^^^^^^^^^^^ .. autosummary:: :toctree: :nosignatures: :hide_from_toctree: :template: _custom_autosummary_class.rst SourceConfig .. ############################################################################ Exceptions ############################################################################ .. ############################################################################ Sub modules ############################################################################ .. ############################################################################ Others ############################################################################ .. raw:: html