Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#21 Documentation generation under Unix

closed
nobody
None
5
2010-09-05
2010-08-08
No

The documentation generating script `documentation/drdoc.py` has several problems. Is was not able to start the `pyrst2html.py` under Unix because a) executables are *not* searched in the current working directory and b) that file lacks the execution rights.

Furthermore current `docutils` embed the docutils style sheet into the HTML instead of just linking to a relative `default.css`. So there are some extra command line options needed. While I fixed that I also added the `--cloak-email-addresses` option to make it a bit harder for spammers to harvest email addresses from the HTML. :-)

I have the complete rewritten script attached instead of a patch because it is essentially a rewrite and the patch is much bigger. :-)

BTW: What do you think about switching from `SilverCity` to `pygments` for the syntax highlighting in the documentation? `pygments` is actively developed and pure python. `SilverCity` seems to be stuck in the year 2006, there are Windows binaries for max. Python 2.5 and no package in Ubuntu. I needed to install from source which requires a C++ compiler.

Discussion

  •  
    Attachments
    • status: open --> closed
     
  • Switched to Sphinx.