1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
====================
Sphinx documentation
====================
DIJITSO is documented using Sphinx and reStructured text. The
documentation is hosted at http://fenics-dijitso.readthedocs.org/. The
online documentation is automatically updated upon pushes to the UFL
master branch.
Building the documentation locally
==================================
The HTML documentation can be built locally using::
make html
In order for changes in the docstring to be propagated to the html
pages, the package must be installed anew. In other words, sphinx reads the
docstrings from the installed code, not the source code.
|
