====================
Sphinx documentation
====================

FFC is documented using Sphinx and reStructured text.
The documentation is hosted at http://fenics-ffc.readthedocs.org/.

The online documentation is automatically updated upon pushes to the
FFC master branch.


Updating the API documentation
==============================

If the FFC API is changed, the script::

    ./generate-apidoc

must be run to update the autodoc file. The script can be run from any
directory.


Building the documentation locally
==================================

The HTML documentation can be built locally using::

    make html
