Welcome to PyBloqs's documentation!
===================================

.. image:: ../../logo/logo.svg

Installation
------------
For installation steps, please refer to the project `README <https://github.com/manahl/PyBloqs>`_.

General use
-----------
The following section is available as a Jupyter notebook in `docs/source/examples.ipynb`.

.. toctree::
  :maxdepth: 2

  examples.ipynb

Table formatting
----------------
The following section is available as a Jupyter notebook in `docs/source/table_formatting.ipynb`.

.. toctree::
  :maxdepth: 2

  table_formatting.ipynb

Interactive plots
-----------------
PyBloqs supports embedding of interactive plotting libraries such as Bokeh and Plotly

.. toctree::
  :maxdepth: 2

  interactive_plots.ipynb

Configuration
-------------
Local configuration of features like email sending and PDF backend.

.. toctree::
  :maxdepth: 2

  configuration.ipynb

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`