[TYPO3-dev] ReST documentation from extensions

[Dirk Wenzel]

Salut François,

Am 08.04.13 21:01, schrieb François Suter:
>> - have an opportunity to inspect the rendering results (as this is the
>> most cumbersome part for me in writing documentation nowadays: I was
>> never able to predict what my changes in manual.sxw did to the online
>> version. There could be a service which renders a preview for both pdf
>> and html version)
>
> There is already a service for rendering your docs online. It was mostly
> done by Fabien and I'm not entirely familiar with it.
I know that there is such a service but AFAIK it just starts rendering 
after uploading a new version. IMHO it would be better to have a preview 
availabe. Thus a developer would get immediate feedback and would be 
enabled to learn the syntax faster. Otherwise every developer would have 
to setup an environment for rendering by himself.

>> As a developer, I want to have an up-to-date api-documentation of each
>> extension (online?).
>
> That seems harder to achieve. I don't know if it would be feasible to
> integrate all extensions on api.typo3.org.
Probably not.

> I guess it would be possible to
> write an extension which wraps around some phpDoc parser and creates a
> local API reference. We just need someone motivated enough to do it.
AFAIK phpDoc style documentation is mandatory. There should be _anybody_ 
who actualy is using it?!

I'm not shure about this since the workflow and environment of 
developers differ. For those who already use phpDoc for other projects 
it is simple enough to generate it also for alien [wording?] extensions.
Until version 4.7 I always had an EM open for studying the code of 
others. An API browser just would be great.

Cheers
Dirk