← Back to team overview

fenics team mailing list archive

Re: Further reorganization of doc files

 

On 31 August 2010 22:10, Anders Logg <logg@xxxxxxxxx> wrote:
> Garth and I have been discussing the location of the demos and it
> seems clear that they should be part of DOLFIN (not fenics-doc).
>
> In the same way as for the C++ documentation, it is not practical to
> split the demos between two different repositories (doc in one, and
> code in the other). So we put them in the same repository.
>
> Then the question is where. For the C++ documentation, it is obvious
> that the code+documentation should be part of DOLFIN (since the code
> needs to be part of DOLFIN).
>
> For the same reason, the demos need to be part of DOLFIN since we need
> to be able to run and update them frequently while developing.
>
> It's also good to have the same kind of dependency both for C++ code
> and demos, with changes propagating from DOLFIN to fenics-doc, not the
> opposite (or both).
>
> I therefore suggest that we put all the subdirectories inside
> source/demos into DOLFIN_DIR/demo/.
>
> This directory would then contain three subdirectories:
>
>  pde
>  la
>  undocumented
>
> The last directory would contain all demos (uncategorized) which have
> not yet been documented. A simple script can be run from fenics-doc to
> update.

So we pull copies of source code files (*.py, *.ufl, *.cpp) from
DOLFIN to fenics-doc, to be uploaded with the rest of the
documentation on the web server?
Sounds reasonable to me, and the test environment for DOLFIN will stay
as it is now.

Kristian

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



Follow ups

References