dolfin team mailing list archive
-
dolfin team
-
Mailing list archive
-
Message #23517
Re: [Branch ~dolfin-core/dolfin/rognes] Rev 5892: Clean-up targets for doc generation:
Nice!
Will any of the below targets superseed the generatation of docstrings in the
dolfin/swig/generate.py
script?
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
Follow ups