.. include:: ./../../macros.txt
.. include:: ./../../units.txt

.. _STYLE_GUIDE:

Style Guide
===========

|foxbms| has its own style guide, which is a set of conventions about how to
write code and documentation. We enforce a consistent style as it makes it
easier to understand the overall project. This project has general rules and
special rules for C/C++, Python, reStructuredText files and batch and shell
scripts.

The following sections describe the project's general and language specific
guidelines.

.. toctree::
    :maxdepth: 1

    ./guidelines_general.rst
    ./guidelines_c.rst
    ./guidelines_python.rst
    ./guidelines_rst.rst
    ./guidelines_batch_shell.rst
    ./guidelines_yaml.rst
    ./guidelines_overview.rst