On 16/05/11 17:01, Marie E. Rognes wrote: > > > On 16. mai 2011, at 16:57, Anders Logg <l...@simula.no> wrote: > >> On Mon, May 16, 2011 at 04:42:29PM +0200, Martin Sandve Alnæs wrote: >>> On 16 May 2011 16:35, Garth N. Wells <gn...@cam.ac.uk> wrote: >>>> >>>> >>>> On 16/05/11 13:33, Marie E. Rognes wrote: >>>>> >>>>> On 16. mai 2011, at 14:17, Kristian Ølgaard <k.b.oelga...@gmail.com> >>>>> wrote: >>>>> >>>>>> On 16 May 2011 13:49, Marie E. Rognes <m...@simula.no> wrote: >>>>>>> >>>>>>> >>>>>>> On 16. mai 2011, at 12:13, "Garth N. Wells" <gn...@cam.ac.uk> >>>>>>> wrote: >>>>>>> >>>>>>>> I suggest now would be a good point to make new releases of >>>>>>>> UFL, FFC and DOLFIN. There have been a number of improvements >>>>>>>> to UFL, FFC caching, and there have been a good number of >>>>>>>> DOLFIN bugs fixes. New version numbers would be: >>>>>>>> >>>>>>>> UFL: 0.9.1 FFC: 0.9.1 DOLFIN: 0.9.12 >>>>>>>> >>>>>>>> Jump in quick if there is anything that you would like do >>>>>>>> before a release. >>>>>>>> >>>>>>> >>>>>>> I have one thing relating to the documentation, and the demo >>>>>>> documentation in particular. >>>>>>> >>>>>>> In order to more easily keep the demo documentation in sync with >>>>>>> the demos, I think we should move the .rst files from the >>>>>>> separate fenics-doc repo to the corresponding dolfin demo >>>>>>> directories. Any objections? >>>>>> >>>>>> Yes, the whole point of fenics-docs was to collect the >>>>>> documentation in one place, thus separating the documentation from >>>>>> the packages containing the code. >>>>>> >>>>> >>>>> I understand that point, but I don't see it working that well. >>>>> >>>> >>>> I sympathise with this point too, but I'm coming around to the doc being >>>> with the code for maintainability. The doc would be in the same >>>> directory, but we we wouldn't be mixing doc and code in one file. >>>> >>>> We should start a new thread/blueprint on this. It doesn't impact on the >>>> imminent release. >> >> It doesn't impact 0.9.11 but 1.0.0 is also pretty imminent so we >> should try to get to a conclusion quickly. >> > > It would be great to do this before 0.9.11 in order to have a release guinea > pig for the doc/web. >
Something for 0.9.12. Garth > >> Marie has already made some progress on setting this up, in particular >> looking at splitting up the documentation for various versions etc. >> >>> I think having the docs in the same repo as the software makes perfect >>> sense. I can't see any reasons to split them. >> >> There will still be a split between documentation of code (local .rst >> files in demo directories + code comments) and the rest (organization >> of the extracted documentation + web page + styling), which I think is >> good to have. >> > > Yes, me too. > > -- > Marie > >> -- >> Anders >> >> >>> Martin >>> >>>> >>>> Garth >>>> >>>>> Having the demo .rst files with the dolfin demos would (a) make it >>>>> more obvious to update them when updating the code and (b) make it >>>>> easier to ensure valid documentation for stable releases. >>>>> >>>>> Wasn't the API documentation for the DOLFIN library moved in with the >>>>> code for some of the same reasons? >>>>> >>>>> Writing documentation isn't that fun, so I would like to aim for a >>>>> system that is maintainable. >>>>> >>>>> -- Marie >>>>> >>>>> >>>>>> Kristian >>>>>> >>>>>>> (I'm on very flaky wifi until Wednesday morning and at the moment >>>>>>> slightly unable to do anything but occasionally retrieve >>>>>>> email...) >>>>>>> >>>>>>> -- Marie >>>>>>> >>>>>>> >>>>>>>> Garth >>>>>>>> >>>>>>>> _______________________________________________ Mailing list: >>>>>>>> https://launchpad.net/~ffc Post to : >>>>>>>> ffc@lists.launchpad.net Unsubscribe : >>>>>>>> https://launchpad.net/~ffc More help : >>>>>>>> https://help.launchpad.net/ListHelp >>>>>>> >>>>>>> _______________________________________________ Mailing list: >>>>>>> https://launchpad.net/~ffc Post to : ffc@lists.launchpad.net >>>>>>> Unsubscribe : https://launchpad.net/~ffc More help : >>>>>>> https://help.launchpad.net/ListHelp >>>>>>> >>>> >>>> >>>> _______________________________________________ >>>> Mailing list: https://launchpad.net/~dolfin >>>> Post to : dol...@lists.launchpad.net >>>> Unsubscribe : https://launchpad.net/~dolfin >>>> More help : https://help.launchpad.net/ListHelp >>>> >>> >>> _______________________________________________ >>> Mailing list: https://launchpad.net/~ufl >>> Post to : u...@lists.launchpad.net >>> Unsubscribe : https://launchpad.net/~ufl >>> More help : https://help.launchpad.net/ListHelp >> >> _______________________________________________ >> Mailing list: https://launchpad.net/~dolfin >> Post to : dol...@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~dolfin >> More help : https://help.launchpad.net/ListHelp > > _______________________________________________ > Mailing list: https://launchpad.net/~ffc > Post to : ffc@lists.launchpad.net > Unsubscribe : https://launchpad.net/~ffc > More help : https://help.launchpad.net/ListHelp _______________________________________________ Mailing list: https://launchpad.net/~ffc Post to : ffc@lists.launchpad.net Unsubscribe : https://launchpad.net/~ffc More help : https://help.launchpad.net/ListHelp
