.. pyCoilGen documentation master file, created by
   sphinx-quickstart on Tue Sep 19 14:51:08 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

pyCoilGen User Guide
====================
|licence| |pypi| |semver| |version| |autopep8|

.. |licence| image:: https://img.shields.io/pypi/l/pycoilgen
   :target: https://github.com/kev-m/pyCoilGen/blob/main/LICENSE
   :alt: PyPI - License
.. |pypi| image:: https://img.shields.io/pypi/v/pycoilgen
   :target: https://pypi.org/project/pycoilgen/
   :alt: PyPI
.. |semver| image:: https://img.shields.io/badge/semver-2.0.0-blue
   :target: https://semver.org/
   :alt: SemVer 2.0.0
.. |version| image:: https://img.shields.io/pypi/pyversions/pycoilgen
   :alt: PyPI - Python Version
.. |autopep8| image:: https://img.shields.io/badge/code%20style-autopep8-000000.svg
   :target: https://pypi.org/project/autopep8/
   :alt: Code style - Black

.. image:: figures/Logo_small.png
  :alt: pyCoilGen logo, a cylinder lying on its side with a complex wire wrapped around it. The word pyCoilGen written underneath.

.. toctree::
   :maxdepth: 2
   :numbered: 4

   overview.md
   installation.md
   quick_start.md
   configuration.md
   results.md
   glossary.md