*****************************************
Welcome to the simplebuild documentation!
*****************************************

..  figure:: images/simplebuild_example_buildsummary.png
    :figwidth: 60%
    :align: right

Welcome to the documentation of "simplebuild", a simple to use collaborative
build system for projects with mostly C++, C and Python code. It is primarily
intended for usage by scientific developers without a strong SW-engineering
background.

Note, that you can browse this documentation in order via the button marked
**"Next"** (or use your keyboards Left and Right arrow keys as a short
cut). Alternatively, you can use the menu or the search box to navigate to the
relevant parts of the documentation.

.. admonition:: Recommended publications for citing
  :class: tip

  | T Kittelmann et al 2014 J. Phys.: Conf. Ser. 513 022017
  | `DOI 10.1088/1742-6596/513/2/022017 <https://doi.org/10.1088/1742-6596/513/2/022017>`_
  | K Kanaki, T Kittelmann, et al 2018 Physica B, Condens. Matter 551 386–389
  | `DOI 10.1016/j.physb.2018.03.025 <https://doi.org/10.1016/j.physb.2018.03.025>`_

.. toctree::
   :hidden:
   :maxdepth: 3

   intro.rst
   install.rst
   usage.rst
   packages.rst
   sbldpy.rst
   simplebuilddotcfg.rst
   cmdline.rst
   about.rst
   contact.rst

.. toctree::
   :hidden:

.. sidebar-links::
   :github:
   :pypi: simple-build-system

   Conda <https://anaconda.org/conda-forge/simple-build-system>
   Issue tracker <https://github.com/mctools/simplebuild/issues>
   license.rst
   Logo <https://github.com/mctools/simplebuild-logo>
   dgcode <https://mctools.github.io/simplebuild-dgcode>