Sprocket Documentation
======================

`Sprocket <https://sprocket.bio/>`_ is a high-performance, modern, and open-source workflow engine
for bioinformatics. This is the API documentation and examples for its Python bindings. For more
information and installation instructions, please see `Sprocket's
website <https://sprocket.bio/python-bindings.html>`_.

.. Sidebar table of contents:

.. toctree::
   :caption: API
   :maxdepth: 2
   :hidden:

   api/index
   api/diagnostics
   api/grammar/index
   api/grammar/grammar
   api/grammar/parser
   api/grammar/version

.. toctree::
   :caption: Examples
   :maxdepth: 2
   :hidden:

   examples/emit_diagnostics
   examples/event_stream
   examples/syntax_highlighter