dolfin team mailing list archive

[Anders Logg <logg@xxxxxxxxx>]

On Tue, Aug 31, 2010 at 03:36:15PM +0200, Kristian Ølgaard wrote:
> On 31 August 2010 15:14, Anders Logg <logg@xxxxxxxxx> wrote:
> > On Tue, Aug 31, 2010 at 12:14:52PM +0200, Anders Logg wrote:
> >> On Tue, Aug 31, 2010 at 11:46:10AM +0200, Marie Rognes wrote:
> >> > On 31. aug. 2010 11:45, Anders Logg wrote:
> >> > > On Tue, Aug 31, 2010 at 11:23:10AM +0200, Kristian Ølgaard wrote:
> >> > >
> >> > >> On 31 August 2010 11:12, Anders Logg <logg@xxxxxxxxx> wrote:
> >> > >>
> >> > >>> On Tue, Aug 31, 2010 at 11:08:01AM +0200, Kristian Ølgaard wrote:
> >> > >>>
> >> > >>>> On 31 August 2010 10:59, Anders Logg <logg@xxxxxxxxx> wrote:
> >> > >>>>
> >> > >>>>> Kristian, is it ok if I reorganize the demo doc files somewhat?
> >> > >>>>>
> >> > >>>>> I think it would be more practical to have
> >> > >>>>>
> >> > >>>>>  demo/pde/poisson/cpp/{index.rst, main.cpp, ...}
> >> > >>>>>  demo/pde/poisson/python/{index.rst, demo.py, ...}
> >> > >>>>>  demo/pde/poisson/common/{index.txt}
> >> > >>>>>
> >> > >>>> Why the common/index.txt? Shouldn't it just be:
> >> > >>>> poisson/poisson.txt (eqns. etc.)
> >> > >>>> poisson/cpp/{poisson.rst, main.cpp}
> >> > >>>> poisson/python/{poisson.rst, demo.py}
> >> > >>>> ?
> >> > >>>>
> >> > >>> Yes, that's better. But isn't index.rst better than poisson.rst?
> >> > >>> In the same way as we name all demos demo.py or main.cpp. Then
> >> > >>> everyone knows what expect, like every demo should have a main.cpp and
> >> > >>> an index.rst.
> >> > >>>
> >> > >> I think of index.rst as something which contains a toctree (overview
> >> > >> of a directory) and includes other rst files.
> >> > >> The poisson.rst contains the source code for documentation of the
> >> > >> Poisson demo. But maybe documentation.rst is better and rename
> >> > >> poisson.txt --> common.txt while at it?
> >> > >> Then we have:
> >> > >> poisson/common.txt (eqns. etc.)
> >> > >> poisson/cpp/{documentation.rst, main.cpp}
> >> > >> poisson/python/{documentation.rst, demo.py}
> >> > >>
> >> > > That sounds good.
> >> > >
> >> > > I'll finish up the demo I'm working on now (Navier-Stokes) and will
> >> > > push that before I attempt any changes.
> >> > >
> >> > >
> >> >
> >> > Please wait a second for mixed Poisson too.
> >>
> >> ok.
> >
> > Can I move around/rename the demo doc files now? Anyone wanting to
> > push something before?
>
> Fine with me, I'm only working on the Python programmer's reference.
>
> Kristian

Good to hear since I already started. :-)

--
Anders