[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Quick way to recreate docs

From: Graham Percival
Subject: Re: Quick way to recreate docs
Date: Fri, 26 Aug 2011 02:59:19 +0100
User-agent: Mutt/1.5.20 (2009-06-14)

On Thu, Aug 25, 2011 at 04:05:14PM +0100, Phil Holmes wrote:
> I'm looking at documenting this, and I think it needs to go in 2
> places: the section on compiling the docs: 4.6.2 Generating
> documentation

Yes, definitely!

> and the section in 2.3 Compiling with lilydev on
> making docs.

Please not.  That would complicated the simple instructions too
much.  People working on the documentation in detail should find
their way to CG 4.6.2 eventually.
... hmm, if there isn't a link to that section from somewhere in
CG 5 Documentation (maybe in "tips for writing docs"), there
should definitely be such a link.

> "The documentation is put in 'out-www/offline-root/'."  That's not
> strictly true.

Are you saying that isn't strictly true because it's in a
subdirectory?  I think that's fine; I just want to make sure that
they're not looking in the wrong set of directories.

If I made a mistake in identifying the main directory, then we
should definitely fix that ASAP.

>  It also says that you can view the docs with:
> "firefox ~/lilypond-git/build/out-www/offline-root/index.html"
> That is true, but only because it redirects to where the
> documentation really is.

I think the redirection is ok; I don't want to have a huge
complicated directory there.  (ok, it's already fairly complicated
from a windows or osx perspective, but I couldn't see any way to
reduce it further)

> You OK with me changing this at the same time?

I'd rather not; that's a separate issue from the "quick doc
compile".  Let's get those instructions pushed ASAP, and have a
more leisurely discussion of the redirect and/or related problems

I'll review a patch for the "quick doc compile" CG instructions
quickly (no pun intended) and we can get that pushed without
waiting for a countdown.

- Graham

reply via email to

[Prev in Thread] Current Thread [Next in Thread]