dolfin team mailing list archive

[Anders Logg <logg@xxxxxxxxx>]

On Fri, Aug 27, 2010 at 09:44:57AM +0200, Kristian Ølgaard wrote:
> On 27 August 2010 09:34, Garth N. Wells <gnw20@xxxxxxxxx> wrote:
> >
> >
> > On 27/08/10 08:13, Kristian Ølgaard wrote:
> >>
> >> On 27 August 2010 09:03, Garth N. Wells<gnw20@xxxxxxxxx>  wrote:
> >>>
> >>>
> >>> On 27/08/10 07:59, Kristian Ølgaard wrote:
> >>>>
> >>>> On 27 August 2010 08:57, Garth N. Wells<gnw20@xxxxxxxxx>    wrote:
> >>>>>
> >>>>>
> >>>>> On 27/08/10 07:48, Kristian Ølgaard wrote:
> >>>>>>
> >>>>>> On 26 August 2010 22:54, Garth N. Wells<gnw20@xxxxxxxxx>      wrote:
> >>>>>>>
> >>>>>>> I need to run generate.py in dolfin/swig because of some DOLFIN
> >>>>>>> change,
> >>>>>>> but
> >>>>>>> now I get the error:
> >>>>>>>
> >>>>>>> Traceback (most recent call last):
> >>>>>>>  File "generate.py", line 91, in<module>
> >>>>>>>    update your PYTHONPATH variable?" % what)
> >>>>>>> ImportError: Could not import the docstrings module
> >>>>>>>  (error: No module named docstrings),
> >>>>>>>  update your PYTHONPATH variable?
> >>>>>>>
> >>>>>>> I guess this is related to the documentation changes?
> >>>>>>
> >>>>>> Yes, we need it to generate the docstrings.i file. The docstrings
> >>>>>> module will also be copied to site-packages/dolfin.
> >>>>>>
> >>>>>
> >>>>> I was hoping you'd tell me how to fix it. All the Python scripts in
> >>>>> dolfin/swig give an error.
> >>>>
> >>>> You need to add fenics-doc/source/programmers-reference/python to
> >>>>  PYTHONPATH.
> >>>>
> >>>
> >>> Is there anyway we can make it stand-alone? I thought the primary purpose
> >>> was to just update the list of header files for SWIG.
> >>
> >> I got the impression that generate.py was not run that often because
> >> it generates docstrings.i which take quite a long time with the old
> >> approach using Doxygen xml files. (with the docstrings module it will
> >> be fast). If we don't generate the docstrings.i file the documentation
> >> will be wrong so even if we split that part of the generate.py file,
> >> we still need to run some other script subsequently.
> >>
> >
> > It's not run often (only when the header files are added or removed), but it
> > seems strange to make DOLFIN dependent on fenics-doc.
>
> Well, if we want the information of
>
> >>> help(dolfin.cpp.Mesh.str)
>
> to be identical to what we have in the documentation (which is a
> design goal of FEniCS documentation) we need to do it this way.

I suggest the opposite: making fenics-doc depend on DOLFIN:

1. Make docstrings.i a part of DOLFIN

2. Generate C++ .rst files in the Programmer's Reference from DOLFIN

--
Anders


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

--
Anders