Restructure demos

[Martin Sandve Alnæs]

The demos should be split into

demo/
    documented/
        womersley2d/
            demo_womersley2d.py
            README.rst
        aneurysm/
            demo_aneurysm.py
            README.rst
            mesh.xml.gz
    undocumented/
        something/
            demo_foobar.py

To do this requires getting rid of demo_main.py, so that's the first step.

[Martin Sandve Alnæs]

The file names should follow some convention. I like the dolfin style except it has non-importable demo file names like 'demo_stokes-iterative.py'. We need importable.

For a problem class FlowAroundCylinder, three alternatives, pick one:

demo/undocumented/FlowAroundCylinder/demo_FlowAroundCylinder.py

demo/undocumented/flow_around_cylinder/demo_flow_around_cylinder.py

demo/undocumented/flowaroundcylinder/demo_flowaroundcylinder.py

The second is easier to read, the last is easier to type.

[Øyvind Evju]

I like the way it is today, actually. Don't see a reason for prepending demo to the filename. CamelCase foldername and lower case filename also works for me.

[Martin Sandve Alnæs]

I changed it to demo/undocumented/FlowAroundCylinder/FlowAroundCylinder.py etc.

[Øyvind Evju]

Ok :)

So are we happy with this, then?

[Øyvind Evju]

There's the README.rst you're suggesting. Isn't it enough to use docstrings in the py-files, and use sphinx to create pretty pretty documentation?

[Martin Sandve Alnæs]

That's absolutely fine.