User documentation
==================

This folder holds the source files for the B3 user documentation.

This documentation is built using the [Sphinx](http://sphinx-doc.org/) project which uses the
[reStructuredText](http://docutils.sourceforge.net/) syntax.


How to build the doc
--------------------

- make sure to have Sphinx installed on your system
- go to the `b3/docs/user_documentation` folder
- run the `make` command

This will produce the doucmentation in HTML format in the `_build` directory.

