Documentation overview
FEniCS documentation should consist of the following pieces:
1.a FEniCS Tutorial (C++)
1.b FEniCS Tutorial (Python)
2.a FEniCS User Manual (C++)
2.b FEniCS User Manual (Python)
3.a FEniCS Demos (C++)
3.b FEniCS Demos (Python)
These pieces are described in separate blueprints.
(1) and (2) should be available in both PDF and HTML, with emphasis on HTML.
(3) should be available as HTML and source code.
Blueprint information
- Status:
- Complete
- Approver:
- None
- Priority:
- Undefined
- Drafter:
- Anders Logg
- Direction:
- Needs approval
- Assignee:
- Kristian B. Ølgaard
- Definition:
- Discussion
- Series goal:
- None
- Implementation:
-
Implemented
- Milestone target:
- None
- Started by
- Kristian B. Ølgaard
- Completed by
- Garth Wells
Related branches
Related bugs
Sprints
Whiteboard
Below is an overview of what is left to be done for the FEniCS documentation to be complete.
* Tutorial
- Hans Petter is working on translating his TEX source to reST for the Python version.
- Figure out if there are some common parts of the text which can be shared with the C++ version.
- Fill in blanks for C++ version.
- This work can be completed independently of the other parts since we can already use references like
:py:class:`Foo` :cpp:class:`Foo`.
* Demos
- Framework is in place.
- Add documentation for all demos in the dolfin/
- Again, this work can be completed independently of the other parts since we can already use references like
:py:class:`Foo` :cpp:class:`Foo`.
* Programmer's reference
- Add documentation for missing classes functions in the *.h files in DOLFIN.
- Add/improve docstrings for the extended methods in the *_post.i files and the
Python layer in dolfin/
- Add appendices for FFC, UFC and UFL. Translate the current manuals to reST and improve the
docstrings in the module such that we can generate the programmer's reference for the modules
automatically.
As we document the interface we have to fix and improve the code in
dolfin/
(double* --> numpy.array etc.). It is working for only a limited range of types at the moment.
