[CPS-devel] Building documentation for CPS products

Dave Kuhlman dkuhlman at cutter.rexx.com
Thu Jan 5 01:56:29 CET 2006


I've implemented a Python script for building the documentation in
the /doc/ directories of CPS products.  This script will do the
following:

- 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.

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

-- 
Dave Kuhlman
http://www.rexx.com/~dkuhlman
-------------- next part --------------
A non-text attachment was scrubbed...
Name: doc_tools-1.0a.zip
Type: application/x-zip-compressed
Size: 13999 bytes
Desc: not available
Url : http://lists.nuxeo.com/pipermail/cps-devel/attachments/20060104/273f3d67/doc_tools-1.0a-0001.bin


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.