← Back to team overview

dolfin team mailing list archive

Re: Reorganization of demo doc files

 

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}
?

> But the toctree layout remains the same. Or would the above break the
> toctree? Is it linked to how we organize the directories?

I think it should be possible, but where do you want to put
demo/cpp/index.rst? The toctree in this file should then be
reorganized of course.

> The reason for the above change is that it seems practical to keep the
> C++ and Python versions of a demo close (on file, but they would be on
> different pages in the documentation).

Why is this practical? To keep the source tree identical to the
dolfin/demo structure (which will be deleted soon anyway)?
I just thought it was easier to split the two versions as early as
possible since the documentation will be different anyway, but I won't
object if you like to reorganize things.

Kristian

> --
> Anders
>
> _______________________________________________
> Mailing list: https://launchpad.net/~dolfin
> Post to     : dolfin@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~dolfin
> More help   : https://help.launchpad.net/ListHelp
>



Follow ups

References