[CPS-devel] Building documentation for CPS products

[M.-A. DARCHE]

Dave Kuhlman a écrit :
> 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.
> 

That's great. Thanks for the hard work, current and past.

Just to let you know it is now possible to put reStructured text
in the Text Widgets. This is in the trunk.


> I've attached the script, documentation (README.txt and
> README.html), and a support file.
> 

The README is very precise and useful.

Before giving you comments or suggestions I would like to test
the output a bit.

I am having the following error when trying the script. Maybe this is
something simple but you will find it faster than me.

/usr/local/zope/instance/cps-zope2.9/Products$ doc_tools/buildCPSdocs.py 
-f -i -w -x doc_tools/doc_directories.xml

##
## Building HTML
##

Processing directory: ./CPSBlog/doc

Processing directory: ./CPSBoxes/doc
     File: ./CPSBoxes/doc/howto-box_overriding-en.txt --> 
./CPSBoxes/doc/howto-box_overriding-en.html
Traceback (most recent call last):
   File "doc_tools/buildCPSdocs.py", line 642, in ?
     main()
   File "doc_tools/buildCPSdocs.py", line 618, in main
     options.quiet, options.update)
   File "doc_tools/buildCPSdocs.py", line 153, in generate_html
     settings_overrides=settings_overrides)
   File "/usr/lib/site-python/docutils/core.py", line 335, in publish_file
     enable_exit_status=enable_exit_status)
   File "/usr/lib/site-python/docutils/core.py", line 513, in 
publish_programmatically
     output = pub.publish(enable_exit_status=enable_exit_status)
   File "/usr/lib/site-python/docutils/core.py", line 196, in publish
     output = self.writer.write(document, self.destination)
   File "/usr/lib/site-python/docutils/writers/__init__.py", line 72, in 
write
     self.translate()
   File "/usr/lib/site-python/docutils/writers/html4css1.py", line 102, 
in translate
     visitor = self.translator_class(self.document)
   File "/usr/lib/site-python/docutils/writers/html4css1.py", line 200, 
in __init__
     stylesheet = utils.get_stylesheet_reference(settings)
   File "/usr/lib/site-python/docutils/utils.py", line 458, in 
get_stylesheet_reference
     assert not settings.stylesheet, \
AssertionError: stylesheet and stylesheet_path are mutually exclusive.


-- 
Marc-Aurèle DARCHE
NUXEO (Paris, France)                     http://nuxeo.com/
Nuxeo Collaborative Portal Server (CPS)   http://www.cps-project.org/
Gestion de contenu web / portail collaboratif / logiciel libre