.. BGlib documentation master file, created by
   sphinx-quickstart on Sun Jul 12 16:57:01 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

BGlib Documentation
===================

**Band Excitation and General Mode analysis and visualization codes**

.. note::

   Documentation under construction

Jump to our `GitHub project page <https://github.com/pycroscopy/BGlib>`_

Documentation Index
-------------------
.. toctree::
   :glob:
   :maxdepth: 1
   :caption: BGlib

   about

Source code API
---------------
.. autosummary::
   :toctree: _autosummary
   :template: custom-module-template.rst
   :recursive:

   BGlib

* :ref:`modindex`

.. toctree::
   :glob:
   :maxdepth: 2
   :caption: Examples

   notebooks/**/index