[Top][All Lists]

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

Re: Quick way to recreate docs

From: Phil Holmes
Subject: Re: Quick way to recreate docs
Date: Thu, 25 Aug 2011 16:05:14 +0100

----- Original Message ----- From: "Phil Holmes" <address@hidden>
To: "Graham Percival" <address@hidden>
Cc: <address@hidden>
Sent: Friday, August 05, 2011 3:51 PM
Subject: Re: Quick way to recreate docs

----- Original Message ----- From: "Graham Percival" <address@hidden>
To: "Phil Holmes" <address@hidden>
Cc: <address@hidden>
Sent: Thursday, August 04, 2011 8:03 PM
Subject: Re: Quick way to recreate docs

On Thu, Aug 04, 2011 at 04:58:08PM +0100, Phil Holmes wrote:
Surprisingly, I get:

address@hidden:~/lilypond-git/build$ touch Documentation/notation.tely
address@hidden:~/lilypond-git/build$ make out=www
make: Nothing to be done for `Documentation/out-www/notation.pdf'.

ok, apparently you need to cd into the directory.
 cd build/
 cd Documentation/
 touch ../../Documentation/contributor.texi
 make out=www out-www/contributor-big-page.html

replace with contributor.pdf or contributor/index.html as desired.

Could you investigate this series of commands and stick them in
the CG?

Excellent. That seems to work. Only problem is that in all my messing around, I've got the build directory pretty messed up, so I'm going to have to clean everything up before I can do anything else. I'll be back after a complete rebuild....

OK.  As you say running:

~/lilypond-git/build/Documentation$ touch ../../Documentation/contributor.texi
~/lilypond-git/build/Documentation$ make out=www out-www/contributor.pdf

builds contributor.pdf. This does work for the other docs, AFAICS from a non-exhaustive check.

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 and the section in 2.3 Compiling with lilydev on making docs. Reading these, they say:

"The documentation is put in 'out-www/offline-root/'." That's not strictly true. 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. It's actually in /lilypond-git/build/out-www/offline-root/Documentation/web/ . I think the statement of it being in out-www/offline-root/ is misleading, since contributors may go there, find most of the docs not present, and find other incomplete versions elesewhere. You OK with me changing this at the same time?

Phil Holmes

reply via email to

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