DOLFIN Programmer's reference
The FEniCS Programmer's reference should be handled in the following way:
* Extract docstrings from the C++ source in DOLFIN
* Generate the reST files for the C++ interface and convert to HTML and PDF using Sphinx.
* Generate docstrings for the dolfin.cpp Python module and reST files.
* Use autodoc in Sphinx to convert the dolfin module to HTML and PDF.
* It should replace the current user manuals for DOLFIN, FFC, UFL and UFC.
* Emphasis should be on documenting the DOLFIN user interface. Details for FFC, UFL and UFC should be placed in Appendix.
* FFC, UFC, and UFL are handled by Sphinx autodoc, perhaps we want to generate reST files too or do we rely on handwritten files?
* It should include numerous small examples (code snippets) that illustrate each function.
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
The framework for writing the programmer's reference is in place. We just need to add documentation for all classes and functions defined in the header files in DOLFIN.
MER: I'm renaming this to DOLFIN Programmer's reference. Suggest FFC/UFL etc generate their own. We can link to these from DOLFIN using intersphinx.
