.. Brokenspoke Analyzer documentation master file, created by
   sphinx-quickstart on Sat Jul 23 15:36:59 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

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

.. warning::

  Be aware that running an analysis can take several hours!

.. toctree::
   :maxdepth: 1
   :caption: GENERAL:

   about
   resources

.. toctree::
   :maxdepth: 1
   :caption: TUTORIALS:

   workflow

.. toctree::
   :maxdepth: 1
   :caption: HOW-TO GUIDES:

   how-to/custom-input-files.md
   how-to/analyze-bike-infrastructure.md

.. toctree::
   :maxdepth: 1
   :caption: REFERENCE:

   commands
   regions
   shapefile-data-dictionary

.. toctree::
   :maxdepth: 1
   :caption: DEVELOPMENT:

   code-of-conduct
   CONTRIBUTING
   CHANGELOG