[Dune-devel] CMake documentation with Sphinx

[Dominic Kempf]

Hey Christoph,

I was thinking about how the documentation should be built and I came up
with the following proposal:

* Whenever you build CMake documentation in a module you get a piece of
documentation covering
  the module itself and all its dependencies.
* Every module can add something to the Introduction part, by shipping a
file doc/buildsystem/dune-foo.rst
* dune-common is the only core module, that builds a CMake doc during make
doc (the other core modules
  do not add much value, so its basically redundant)
* The documentation for the webpage is generated from a module that depends
on all core modules.
* The duneproject script should be changed to add a buildsystem doc in
every user module, that collects
  the CMake API from all requirements, so users have a "personal" doc.
(still TODO)

That is my idea, I am open to feedback here.

Dominic

On Fri, Oct 16, 2015 at 7:23 AM, Christoph Grüninger <
christoph.grueninger at iws.uni-stuttgart.de> wrote:

> Hi Dominic,
> I just tried the Sphinx-based CMake documentation. It looks good so far
> for dune-common, thank you.
> With dune-grid and dune-istl Sphinx was not run as part of "make doc".
> What should I do? Or is this expected?
>
> Bye
> Christoph
>
> --
> A mathematician is a scientist who can figure out anything, except
> such simple things as squaring the circle and trisecting an angle.
> [Evan Esar (1899-1995), Esar's Comic Dictionary]
>
>
> _______________________________________________
> Dune-devel mailing list
> Dune-devel at dune-project.org
> http://lists.dune-project.org/mailman/listinfo/dune-devel
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.dune-project.org/pipermail/dune-devel/attachments/20151016/f4385cf7/attachment.htm>