FFC

Move contents from old FFC manual to appendix

Registered by Kristian B. ├ślgaard

* Transfer relevant contents from the old FFC manual to rst files. Make sure that all info is still relevant e.g., the form language chapter can be deleted since it should be covered in the UFL manual.

* Some of the information from the FFC chapter in the FEniCS-book might also be relevant.

* Update docstrings in the code to let Sphinx generate the documentation for the interface automatically.

Blueprint information

Status:
Complete
Approver:
None
Priority:
Medium
Drafter:
None
Direction:
Needs approval
Assignee:
Marie Rognes
Definition:
Discussion
Series goal:
None
Implementation:
Implemented
Milestone target:
milestone icon 1.0.0
Started by
Marie Rognes
Completed by
Marie Rognes

Related branches

Sprints

Whiteboard

MER: A first (simple) step is to generate some documentation using autodoc
AL: What is the status on this? Still planning to do this before 1.0?

MER: Depends. Do we want a separate FFC manual or is the book chapter enough? I would say that autodoc + book chapter should suffice.

KBO: +1, the FFC compiler has been redesigned and the form language is moved to UFL. I doubt that there is much useful material left in the old manual. Perhaps we could improve on the docstrings in the code, but a first stab is to autodoc the classes and functions.

MER: autodoc is already in place: run ./scripts/makedoc More work on the docstrings is clearly needed in order for it to be of any use, but I think that's the way to go. Let's close this blueprint, and encourage improving docstrings as we touch code.

KBO: Right, I forgot that it was working already. How does one close a blueprint without marking it as implemented?

MER: Don't know, but I think it is ok to say implemented.

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.