dolfin team mailing list archive

[Martin Sandve Alnæs <martinal@xxxxxxxxx>]

On 16 May 2011 16:35, Garth N. Wells <gnw20@xxxxxxxxx> wrote:
>
>
> On 16/05/11 13:33, Marie E. Rognes wrote:
>>
>> On 16. mai 2011, at 14:17, Kristian Ølgaard <k.b.oelgaard@xxxxxxxxx>
>> wrote:
>>
>>> On 16 May 2011 13:49, Marie E. Rognes <meg@xxxxxxxxx> wrote:
>>>>
>>>>
>>>> On 16. mai 2011, at 12:13, "Garth N. Wells" <gnw20@xxxxxxxxx>
>>>> 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.

I think having the docs in the same repo as the software makes perfect
sense. I can't see any reasons to split them.

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@xxxxxxxxxxxxxxxxxxx Unsubscribe :
>>>>> https://launchpad.net/~ffc More help   :
>>>>> https://help.launchpad.net/ListHelp
>>>>
>>>> _______________________________________________ Mailing list:
>>>> https://launchpad.net/~ffc Post to     : ffc@xxxxxxxxxxxxxxxxxxx
>>>> Unsubscribe : https://launchpad.net/~ffc More help   :
>>>> https://help.launchpad.net/ListHelp
>>>>
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~dolfin
> Post to     : dolfin@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~dolfin
> More help   : https://help.launchpad.net/ListHelp
>