[TYPO3-dev] Documentation of my extension not rendered

[Xavier Perseguers]

Hi Charles,

Charles Brunet wrote:
> I recently uploaded a new extension to TER (extension key: cb_foundation)
> and I was expecting the manual to be automatically rendered. However, this
> is not the case. In Sphinx, on my local installation, there is not error,
> only those two warnings:
> 
> _IncludedDirectives.rst:1: WARNING: document isn't included in any toctree
> TyposcriptReference.rst:22: WARNING: Pygments lexer name u'typoscript' is
> not known

By reading another email, seems that we had a temporary problem after an
update of some configuration files. Meaning some manuals failed with no
real reason.

I just re-rendered your manual and apart this warning there is no
problem (maybe some misconfiguration with PDF rendering though).

http://docs.typo3.org/typo3cms/extensions/cb_foundation/

It should appear soon on TER as well.

I will put back every recently updated extension in the rendering queue.

> Is there a way I could know what went wrong with my documentation? Do I
> need to generate a new version of my extension each time I need to correct
> a bug in documentation?

Unfortunately not, at the moment there is no way for you except testing
locally with EXT:sphinx (because rendering is extremely similar to what
happens on docs.typo3.org) and reporting if you don't understand, just
as you did.

Kind regards

-- 
Xavier Perseguers
TYPO3 CMS Team Member

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