.. brane documentation master file, created by
   sphinx-quickstart on Wed May 25 01:46:56 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to brane's documentation!
=================================

.. toctree::
   :maxdepth: 2
   :caption: Introduction

   introduction/introduction.md

.. toctree::
   :maxdepth: 1
   :caption: Examples

   examples/package_overview_tour
   examples/unified_interface.md
   examples/hook.md

.. toctree::
   :maxdepth: 2
   :caption: User customization
   :numbered:

   user_def/read.md
   user_def/write.md
   user_def/hook.md

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

   api/brane


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

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