incubator-zeta-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jerome Renard <jerome.ren...@gmail.com>
Subject Re: [zeta-dev] Website
Date Fri, 30 Jul 2010 08:05:38 GMT
Hi there,

On Fri, Jul 30, 2010 at 9:05 AM, Kore Nordmann <mail@kore-nordmann.de>wrote:

> Hi Maxime,
>
> On Fri, 2010-07-30 at 08:33 +0200, Maxime Thomas wrote:
> > Good job !
>
> Thanks.
>
> > Is there a thing we can do about the copy paste that occurred on PHP
> > code ? When you select the code and past it, each line are prefixed by
> > # or number. It could be an improvement.
>
> Those are the code snippets generated by PHPDoc, which uses <ol>. I will
> commit the full custom code used to generate the API docs to the SVN,
> once it has been seconded by the ML.
>
> The PHPDocumentor Code is, let's say, not optimal. It combines Smarty
> templates with PHP code generating HTML code - not that easy to
> customize (beside generating docs and website takes something between 10
> to 300 minutes depending on various factors).
>
> Feel free to fix that, though. :)
>
> > Else, I ve looked to Sphynx, is it only for Python ?
>
> Looked like it to me … Jerome? :)
>

I am currently writing a book using Sphinx and I also deliver my customer
documentation
using SPhinx as well. Basically, Sphinx uses RST + some cool stuff around it
so migrating
ZC tutorials from plain RST to Sphinx is a matter of around 2 hours of work,
just to add the correct
Sphinx instructions to get syntax coloring for example.

However Sphinx is initially built for Python project which means it know
absolutely nothing about
PHP Doc, but coupling the documentation generated by Sphinx and the PHP Doc
should not be that
difficult actually.

Hope that helps :)

-- 
Jérôme Renard
http://39web.fr | http://jrenard.info

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message