[augeas-devel] [PATCH] Add naturaldocs to doc/

[Raphaël Pinson]

On Thu, Sep 11, 2008 at 3:48 AM, David Lutterkort <lutter at redhat.com> wrote:

> On Wed, 2008-09-10 at 18:45 -0700, David Lutterkort wrote:
> > On Wed, 2008-09-10 at 16:12 +0200, Raphael Pinson wrote:
> > > # HG changeset patch
> > > # User Raphael Pinson <raphink at gmail.com>
> > > # Date 1221055915 -7200
> > > # Node ID a2e54bd5c9fd56b804dc94f5690aa66e9f4ce046
> > > # Parent  f4e2629f1b5176c22341c0d84fb57cff4f2bf791
> > > Add naturaldocs to doc/
> > > Add Makefile.am to doc/ and doc/naturaldocs/
> > > Adapt Makefile.am and configure.ac to build docs:
> > >   - add --with-naturaldocs=DIR
> > >   - add --with-pdfdocs
>
> Two more things:
>
> (1) the menu in my browser is pretty jumbled, and it's hard for me to
> navigate through the docs ... the navi for the main site is mixed in
> between docs for Inifile and src/augeas.h


That's the bit about reordering Menu.txt after the first ND launch. In
short, ND does this:
- when first launched, it creates or modifies the Menu.txt. If it manages to
parse files that were not present yet, it adds them (probably not where you
would like them to be)
- you modify Menu.txt to reorganize the files
- when you relaunch ND, it sees that the files it manages to parse are
already all in Menu.txt, and doesn't modify the settings there, so you get
the menu you specified.

(2) we should generate the docs for C code and for lenses completely

> separately; that way, the website can link to them in different places.
> Generally, people will be interested in docs for the C code _or_ the
> lenses, but not both at the same time.
>

Sure, that could be done easily, with two ND commands, although right now
the C API and the lenses are already in two different menus on the doc page.
Isn't that sufficient?


Raphael
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/augeas-devel/attachments/20080911/e0f18a6a/attachment.htm>