###################################################
  The Official Documentation for the hfkpy Package
###################################################

This `repository <https://github.com/Henrik-Kowalkowski/hfkpy>`_ serves as an example and template for Python development.

Questions this repository answers in regard to Python packages:

- How to design a `logical structure <https://github.com/Henrik-Kowalkowski/hfkpy/tree/main/hfkpy>`_
- How to auto document `functions <https://github.com/Henrik-Kowalkowski/hfkpy/blob/main/source/documentation/fitbit.rst>`_
- How to version for stable `releases <https://github.com/Henrik-Kowalkowski/hfkpy/releases>`_
- How to set up `unit tests <https://github.com/Henrik-Kowalkowski/hfkpy/tree/main/tests>`_
- How to set up CICD via `GitHub Actions <https://github.com/Henrik-Kowalkowski/hfkpy/tree/main/.github/workflows>`_
- How to create `vignettes to illustrate usage <https://github.com/Henrik-Kowalkowski/hfkpy/tree/main/source/examples>`_
- How to `install from GitHub <https://github.com/Henrik-Kowalkowski/hfkpy#readme>`_
- How to leverage APIs in Python, like the `Fitbit API <https://github.com/Henrik-Kowalkowski/hfkpy/tree/main/hfkpy/fitbit>`_

Documentation
=============

.. toctree::
   :maxdepth: 2

   documentation/index

Examples
==========

.. toctree::
   :maxdepth: 2

   examples/index

Continuous Integration Continuous Deployment (CICD)
===================================================

.. toctree::
   :maxdepth: 2

   cicd/index

Versioning
==========

.. toctree::
   :maxdepth: 2

   versioning/index

Documenting
===========

.. toctree::
   :maxdepth: 2

   documenting/index

Resources
=========

.. toctree::
   :maxdepth: 2

   resources/index