.. CrystalBuilder documentation master file, created by
   sphinx-quickstart on Tue Jan 14 13:37:00 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

CrystalBuilder
============================
This is Sphinx-generated documentation for the crystalbuilder package, designed for generating 2D and 3D photonic crystals. 




.. toctree::
   :maxdepth: 2
   :caption: Contents:

   CrystalBuilder <self>
   Getting Started <source/getting_started>

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

   source/diamond_examples



.. toctree::
   :maxdepth: 1
   :caption: API Documentation

   source/bilbao
   source/convert
   source/geometry
   source/lattice
   source/vectors