On Friday April 15 2011 09:50:30 Kristian B. Ølgaard wrote:
> On 15 April 2011 17:32, Johan Hake <email address hidden> wrote:
> > On Friday April 15 2011 08:00:02 Kristian B. Ølgaard wrote:
> >> On 15 April 2011 15:17, Garth Wells <email address hidden> wrote:
> >> > On 15/04/11 13:21, Anders Logg wrote:
> >> >> Is it the generate_modules.py script?
> >> > 
> >> > Yes.
> >> > 
> >> >> Does this replace generate_dolfin_python_doc.py?
> >> > 
> >> > I think so, unless
> >> > 
> >> >  generate_dolfin_python_doc.py
> >> > 
> >> > does something more than pulling out doc strings. Kristian?
> >> 
> >> generate_dolfin_python_doc.py also generate files for classes and
> >> functions and use the autoclass/autofunction directives from Sphinx.
> >> generate_modules.py just use automodule. The result is that for
> >> instance the dolfin.cpp module is documented in one big file and one
> >> has to scroll a lot the find the doc of interest. Maybe there's an
> >> easy way to fix this?
> >> 
> >> The problem with generate_dolfin_python_doc.py and the missing
> >> function/index.rst file is that modules like:
> >> 
> >> dolfin.function.function
> >> 
> >> shadows
> >> 
> >> dolfin.function
> > 
> > Would it help to rename the function directory to functions? Are there
> > other similare cases?
> 
> It doesn't matter for the docs since I changed the strategy for
> extracting the docs.
> However, the following is not possible:
> 
> import dolfin
> c = dolfin.function.constant.Constant(1.2)
> Traceback (most recent call last):
>   File "<stdin>", line 1, in <module>
> AttributeError: 'module' object has no attribute 'constant'
> 
> Ideally, we should change the names to allow this usage.
> 
> Same story for compilemodules.

I have fixed this in my branch now. Do I need to update something in the 
fenics-doc too?

Johan

> > If so, we could do the same change for the C++ name too, as the python
> > naming tries to folow the C++ naming. But that is strictly not
> > nessesary.
> 
> I'm indifferent, but since the problem is on the Python side (and we
> generate the Python interface from C++) I don't think the 'fix'
> necessarily should propagate back to C++.
> 
> Kristian
> 
> > Johan
> > 
> >> when importing the dolfin module.
> >> I've been working on a fix for this, such that the documentation is
> >> generated from the files present in the dolfin_dir and not the module
> >> available when simply importing dolfin. (similar to what
> >> generate_modules.py does actually.)
> >> 
> >> Kristian
> >> 
> >> > Garth
> >> > 
> >> >> --
> >> >> Anders
> >> >> 
> >> >> On Fri, Apr 15, 2011 at 11:49:45AM -0000, Garth Wells wrote:
> >> >>> I've used a script that I found to extract the doc automatically.
> >> >>> Take a look at
> >> >>> 
> >> >>>     lp:~fenics-core/fenics-doc/1.0
> >> >>> 
> >> >>> It seems to work well.
> >> > 
> >> > --
> >> > You received this bug notification because you are a member of FEniCS
> >> > Core Team, which is the registrant for FEniCS Documentation.
> >> > https://bugs.launchpad.net/bugs/761516
> >> > 
> >> > Title:
> >> >  programmers-reference/python/index.rst is incomplete
> >> > 
> >> > Status in FEniCS Documentation:
> >> >  Confirmed
> >> > 
> >> > Bug description:
> >> >  The generated file
> >> > 
> >> >      programmers-reference/python/index.rst
> >> > 
> >> >  is incomplete. For example, it does not include
> >> > 
> >> >    function/index.rst
> > 
> > --
> > You received this bug notification because you are a member of FEniCS
> > Core Team, which is the registrant for FEniCS Documentation.
> > https://bugs.launchpad.net/bugs/761516
> > 
> > Title:
> >  programmers-reference/python/index.rst is incomplete
> > 
> > Status in FEniCS Documentation:
> >  Confirmed
> > 
> > Bug description:
> >  The generated file
> > 
> >      programmers-reference/python/index.rst
> > 
> >  is incomplete. For example, it does not include
> > 
> >    function/index.rst