[CPS-devel] Building documentation for CPS products

Florent Guillaume fg at nuxeo.com
Thu Jan 5 12:48:44 CET 2006


On 5 Jan 2006, at 01:56, Dave Kuhlman wrote:
> I've implemented a Python script for building the documentation in
> the /doc/ directories of CPS products.  This script will do the
> following:

And I've seen you've restructuredtext-ified all this docs, thanks a  
lot for that.

> - Build HTML files for .txt files in /doc/ directories.
> - Build PDF files.
> - Generate index files, one for HTML and one for PDF.
> - Produce distribution files containing the source and generated
>   files.

One concern I have is that some of these docs are really old, and  
should be reviewed for accurateness or relevance before being  
included. Otherwise you'll get something of very inequal quality, or  
downright misleading. Not your fault really, but a concern nonetheless.

Florent

> I've attached the script, documentation (README.txt and
> README.html), and a support file.
>
> Eventually, I'd like to use this to build distributions of the
> documentation and then post it at cps-project.org under
> "Documentation/For developers" (or maybe "Documentation/For
> users"?).
>
> The script has a few requirements.  See the README file.
>
> There is still work to do.  In particular, more descriptions of
> the various products need to be added.  These are included in the
> generated index files.
>
> If you have comments or suggestions, I'm interested.
>
> Dave

-- 
Florent Guillaume, Nuxeo (Paris, France)   Director of R&D
+33 1 40 33 71 59   http://nuxeo.com   fg at nuxeo.com




More information about the cps-devel mailing list
More information about CPS: CPS project - CVS - API

Hosting: Nuxeo: Zope service provider


This list archive provided by Nuxeo, the leaders of open source ECM. Check out the Nuxeo 5 open source, standards-based ECM project.