.. include:: ../README.md
   :parser: myst_parser.sphinx_

.. toctree::
   :caption: Modules
   :hidden:

   modules/el
   modules/ph
   modules/elph
   modules/elel
   modules/MPI
   modules/bravais
   modules/dispersion
   modules/dos
   modules/diagrams
   modules/occupations
   modules/md
   modules/eliashberg
   modules/plot
   modules/misc

.. toctree::
   :caption: Models
   :hidden:

   modules/models/graphene
   modules/models/tas2
   modules/models/chain
   modules/models/be

.. toctree::
   :caption: Examples
   :hidden:

   examples/bare
   examples/coulomb
   examples/decay
   examples/defpot
   examples/dos
   examples/cdw_1d
   examples/ssh
   examples/double_bz
   examples/double_delta
   examples/electrons
   examples/a2f
   examples/fan_migdal
   examples/fermi_surface
   examples/fermi_velocity
   examples/fluctuations
   examples/goldstone
   examples/intersections
   examples/isoline
   examples/kekule
   examples/lr
   examples/modes
   examples/md
   examples/occupations
   examples/peierls
   examples/phonons
   examples/phrenorm_graphene
   examples/phrenorm
   examples/phrenorm_3d
   examples/specfun
   examples/projwfc_1d
   examples/projwfc
   examples/projwfc_3d
   examples/quadrupole
   examples/skiing
   examples/smear_tetra
   examples/simstm
   examples/simsts
   examples/supercell_el
   examples/supercell_elel
   examples/supercell_elph
   examples/supercell_ph
   examples/susceptibility
   examples/wannier

.. toctree::
   :caption: More
   :hidden:

   pages/changelog
   pages/contributing
   pages/patches
   genindex