Re: Reference Manual creation

Stefan Seefeld <[email protected]> Tue, 09 Jan 2007 14:50:33 -0500
Newsgroups gmane.comp.documentation.synopsis
Message-ID <[email protected]>
Andreas Fester wrote:
> Hi Stefan,
> 
> when creating the synopsis 0.9 reference as part of the build
> process, without synopsis being actually installed, I need to perform
> the following steps:
> 
> export LD_LIBRARY_PATH=$(CURDIR)/build/ctemp.linux-x86_64/src/lib
> export PYTHONPATH=$(CURDIR)/build/lib.linux-x86_64-2.4
> mkdir $(CURDIR)/build/lib.linux-x86_64-2.4/share
> cp -R $(CURDIR)/share/Synopsis $(CURDIR)/build/lib.linux-x86_64-2.4/share
> python setup.py build_doc --ref-manual --html
> rm -rf $(CURDIR)/build/lib.linux-x86_64-2.4/share
> 
> I think that there is no alternative to setting LD_LIBRARY_PATH and PYTHONPATH,
> so that is not an issue.
> But, what bugs me a bit, is the need to copy the share/Synopsis directory
> into the build tree, to allow synopsis to find image and css files, and
> to remove it again afterwards.
> Is there a better way of doing this?

I have never done that. Obviously, you have to make sure that synopsis
can run. Either installing synopsis or setting LD_LIBRARY_PATH and PYTHONPATH
should do.
Then you simply run 'python setup.py build_doc' with appropriate flags (such
as '-r --html'). There is no need to manually create any directory, or to
manually copy things around. The css, javascript, and png files used by the
reference manual are copied by the HTML formatter itself, and tutorial images
are copied where they are needed, i.e. by the build harness that compiles
Tutorial and DevGuide.

If any of that doesn't work, please report it as a bug. :-)

Thanks,
		Stefan

-- 

      ...ich hab' noch einen Koffer in Berlin...