.. Reynolds documentation master file, created by
   sphinx-quickstart on Wed Jun 21 13:16:15 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Reynolds's documentation!
====================================

`Reynolds`_ is a full featured, scriptable python API of components for the
preprocessing and solver environments of `OpenFoam`_. These components can be
easily combined to build a GUI using any 3D graphics package such as `Blender`_.

.. _Reynolds: https://github.com/dmsurti/reynolds
.. _OpenFoam: http://www.openfoam.com
.. _Blender: http://www.openfoam.com

The main documentation for this library is split into:

* :ref:`user-docs`
* :ref:`dev-docs`
* :ref:`api-docs`

.. _user-docs:

.. toctree::
   :maxdepth: 2
   :caption: User Documentation

   user/faq
   user/using

.. _dev-docs:

.. toctree::
   :maxdepth: 2
   :caption: Developer Documentation

   developer/install
   developer/design
   developer/contribute

.. _api-docs:

.. toctree::
   :maxdepth: 2
   :caption: API Docs

   api/reynolds

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`