dolfin team mailing list archive

["Marie E. Rognes" <meg@xxxxxxxxx>]

On 05/27/2011 08:05 PM, Kristian Ølgaard wrote:
> On 27 May 2011 18:55, Marie E. Rognes<meg@xxxxxxxxx>  wrote:
> > On 05/27/2011 06:21 PM, Johan Hake wrote:
> > > Nice!
> > >
> > > Will any of the below targets superseed the generatation of docstrings in
> > > the
> > >
> > >    dolfin/swig/generate.py
> > >
> > > script?
> >
> >
> > Hahaha. I had no idea that dolfin/swig/generate.py generates docstrings, so
> > probably yes! or no.
> >
> > Why don't you give me a quick run-down of what the idea with the generation
> > of docstrings is, and then I'll fix.
>
> The generate.py script creates the docstrings which is included by
> Swig when creating the cpp.py module.
> These docstrings are then extracted, using autodoc, in the .rst files
> that we're generating from the dolfin module (what you have been
> working on lately).

:-)

Bottomline, the autodoc operates on the "installed" module, and the 
generated docstrings are thus included.

--
Marie


> Kristian
>
> > --
> > Marie
> >
> >
> >
> > > Johan
> > >
> > > On Friday May 27 2011 09:18:24 noreply@xxxxxxxxxxxxx wrote:
> > > > ------------------------------------------------------------
> > > > revno: 5892
> > > > committer: Marie E. Rognes<meg@xxxxxxxxx>
> > > > branch nick: rognes
> > > > timestamp: Fri 2011-05-27 18:16:02 +0200
> > > > message:
> > > >    Clean-up targets for doc generation:
> > > >
> > > >    The following targets are now valid:
> > > >
> > > >    1. To generate reST files from code
> > > >
> > > >      make api_doc    # Generate reST files from dolfin/ (Takes time).
> > > >      make demo_doc   # Copy demo files from demo and add an index layer.
> > > > (Quick.)
> > > >
> > > >    2. To generate html from reST files:
> > > >
> > > >      make html       # Run sphinx in sphinx projects. Requires Sphinx.
> > > >                      # html generated in build/doc/sphinx-cpp/build/html
> > > > and
> > > >                      # build/doc/sphinx-python/build/html
> > > >
> > > >    3. To generate reST and html:
> > > >
> > > >      make doc        # Do all: make api_doc + demo_doc + html. Requires
> > > > Sphinx.
> > > >
> > > >    4. Other auxiliary targets:
> > > >
> > > >      make cpp_html      # Run sphinx in C++ sphinx project. Requires
> > > > Sphinx.
> > > >      make python_html   # Run sphinx in Python sphinx project. Requires
> > > > Sphinx. make all_doc       # make_api + demo_doc. Requires Sphinx.
> > > > modified:
> > > >    CMakeLists.txt
> > > >
> > > >
> > > > --
> > > > lp:~dolfin-core/dolfin/rognes
> > > > https://code.launchpad.net/~dolfin-core/dolfin/rognes
> > > >
> > > > Your team DOLFIN Core Team is subscribed to branch
> > > > lp:~dolfin-core/dolfin/rognes. To unsubscribe from this branch go to
> > > > https://code.launchpad.net/~dolfin-core/dolfin/rognes/+edit-subscription
> > >
> > > _______________________________________________
> > > 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