[TYPO3-english] Getting started to Sphinx

Xavier Perseguers xavier at typo3.org
Tue Sep 24 11:21:01 CEST 2013


Dear TYPO3 community,

With the release yesterday of EXT:sphinx v1.2 [1], you now have an
enhanced reStructuredText editor and a full-fledged environment to
easily and quickly build your documentation projects (either in-house or
extension manuals). This extension aims at becoming "the" documentation
extension.

The extension has been tested on Linux, Mac OS X and Windows and is thus
expected to be working for "everyone".

As you may have noticed, more and more extension authors are now
following the Documentation Team and writing their own extension
documentation using Sphinx/reStructuredText instead of OpenOffice.

Extension manuals are then automatically rendered on docs.typo3.org
after the upload to TER. Extensions providing a standard OpenOffice
manual have it getting converted to Sphinx prior to the actual
rendering, which explains why it doesn't look as beautiful as when
written in Sphinx right away.

Prettiness is not the only reason to switch to Sphinx to write manuals
and guides, it's straightforward to cross-link to other documents or to
embed videos and presentations: [2]

We now would like much more people involved into using
Sphinx/reStructuredText. You can help in many ways:

- Spread the word!

- Translate EXT:sphinx to make it user-friendly for everyone (is quickly
done as they are not many labels) [3]

- Convert your existing extension manual to Sphinx (EXT:sphinx comes
with a converter)

- Use it in your agency to streamline your editor documentation and
advertise it

- Provide feedback to help me improving EXT:sphinx or even join and
contribute to the project


I hope to see more and more users getting addicted to Sphinx :)

Kind regards
Xavier


[1] http://typo3.org/extensions/repository/view/sphinx
[2]
http://docs.typo3.org/typo3cms/extensions/sphinx/1.2.1/UsersManual/Plugins/Index.html#sphinxcontrib-slide
[3] http://translation.typo3.org/projects/TYPO3.TYPO3.ext.sphinx/

-- 
Xavier Perseguers
Release Manager TYPO3 4.6

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



More information about the TYPO3-english mailing list