..
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.config
====================
Overview
--------
.. automodule:: spdl.pipeline.config
API Reference
-------------
..
############################################################################
Functions
############################################################################
.. rubric:: Functions
is\_diagnostic\_mode\_enabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.is_diagnostic_mode_enabled
diagnostic\_mode\_num\_sources
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.diagnostic_mode_num_sources
set\_default\_hook\_class
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.set_default_hook_class
get\_default\_hook\_class
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.get_default_hook_class
set\_default\_queue\_class
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.set_default_queue_class
get\_default\_queue\_class
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.get_default_queue_class
set\_default\_profile\_hook
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.set_default_profile_hook
get\_default\_profile\_hook
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.get_default_profile_hook
set\_default\_profile\_callback
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.set_default_profile_callback
get\_default\_profile\_callback
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
~spdl.pipeline.config.get_default_profile_callback
..
############################################################################
Attributes
############################################################################
..
############################################################################
Classes
############################################################################
..
############################################################################
Exceptions
############################################################################
..
############################################################################
Sub modules
############################################################################
..
############################################################################
Others
############################################################################
.. raw:: html