[TYPO3-dev] ReST documentation from extensions

Xavier Perseguers xavier at typo3.org
Thu May 30 18:06:56 CEST 2013


Hi,

Lately, I enhanced EXT:sphinx [1] to finally take advantage of
EXT:restdoc [2].

As you know, in the latest TER version of EXT:sphinx (0.4.0), I
introduced a way to render and show extension manuals within the
Backend. I compile the documentation as HTML and embed it as a frame.
Simple.

As a work in progress, it is now possible to render the documentation in
JSON as well (I name it "interactive") and if so, I then use EXT:restdoc
to prepare a HTML output using a Fluid template based on the design of
docs.typo3.org. Not every part of the design is yet "mapped" but the
main menu is rendered (and entries marked as "active/current" if
needed), the internal TOC within the left menu slider is rendered as
well and, of course, the content incl. images are rendered.

I've a few crazy ideas for what doing next, so stay tuned! :)

[1] https://forge.typo3.org/projects/extension-sphinx/
[2] https://forge.typo3.org/projects/extension-restdoc/

-- 
Xavier Perseguers
Release Manager TYPO3 4.6

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org




More information about the TYPO3-dev mailing list