New makefile target to produce HTML online documentation

[Robert Collins]

For the OnlineDocumentation specification we need a new makefile target - i.e. 'htmldocs' which will build a nice HTML website containing:
 * The output of bzr help for the non-hidden commands.
 * The bzr manual

[Alexander Belchenko (bialix)]

My installer work has similar improvements to Makefile (target: docs) because I need to ship docs within installers. And because it's already in bzr.dev can you review it and say is suitable for this task?

[Robert Collins (lifeless)]

On Fri, 2006-08-04 at 03:49 +0000, bialix wrote:
> My installer work has similar improvements to Makefile (target: docs)
> because I need to ship docs within installers. And because it's already
> in bzr.dev can you review it and say is suitable for this task?

Its a good start.

A few things we should change: we need to be able to extract just the
documentation I think, so perhaps output into a different dir than the
source is maintained in.

This patch was needed for me to build this:

=== modified file 'Makefile'
--- Makefile 2006-07-31 17:48:17 +0000
+++ Makefile 2006-08-04 06:34:48 +0000
@@ -44,10 +44,10 @@
 htm_files := $(patsubst %.txt, %.htm, $(txt_files)) doc/bzr_man.htm

 %.htm: %.txt
- rst2html.py --link-stylesheet --stylesheet=default.css $*.txt
$*.htm
+ rst2html --link-stylesheet --stylesheet=default.css $*.txt
$*.htm

 doc/bzr_man.txt:
- generate_docs.py -o doc/bzr_man.txt rstx
+ python generate_docs.py -o doc/bzr_man.txt rstx

 docs: $(htm_files)

The exe on linux is rst2html not rst2html.py. For that we could add a
$(PYEXT) variable set to '' on linux and '.py' on windows.

The second one is needed because '.' is not on the path on linux.

So with my patch + a new output dir, I'd be happy to call this
sufficient.

-Rob

--
GPG key available at: <http://www.robertcollins.net/keys.txt>.

[Alexander Belchenko (bialix)]

What about attached patch?

I need to rework it in some special way. Instead of simply rst2html invokation I need to use presetup $PATHEXT environment variable. Otherwise it's not work on Windows.

[John A Meinel (jameinel)]

We now have 'make html-docs' along with 'make clean-docs', etc.