Code review comment for lp:~ian-clatworthy/bzr/pdf-chm-docs-for-2.0

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote :

This patch allows our documentation to be converted to PDF and CHM (Windows Help) format. It also improves the HTML format by using topics instead of mega-documents more frequently.

Here's a summary of the main changes:

* added configuration settings to enable the various guides and tutorials to be converted to pdf

* improved the User Guide in HTML/CHM to use topics instead of one big file

* added a script to break the release notes up into topics

* edited the headings in the release notes to be just the version info, making the PDF and CHM contents read better

* dropped inline table of contents from most documents as otherwise they appear twice

There are still some things to sort out to get the developer docs and foreign languages appearing in different chm files. The version number (2.0rc2) is also hard-coded currently. I'll raise bugs for those and, time permitting, tackle them before 2.0 ships.

The CHM format is required/highly-desirable for the Windows installer so I'd like this reviewed (and hopefully approved) soon please.

« Back to merge proposal