[TYPO3-english] How to create backend module for documentation

Xavier Perseguers xavier at typo3.org
Mon Nov 4 08:11:08 CET 2013

Hi Sergio,

> Your solution about frameset works, but the problem is the Html
> generated with "sphinx" in my local 6.1 installation contains wrong
> paths to Css and Js files. If I want to export this whole Html project
> (it has a lot of subfolders, it is not a standalone Html), and put the
> "_images" and "_static" folders into my extension "Resources/Public"
> folder, I should update all my Htmls to these new paths. I don't know if
> there is a better solution for this, as I am gonna update my
> documentation these days constantly.

You may compile as "singlehtml" to get a single HTML page but you still
will have external resources.

I don't understand where the problem is, the links in the generated HTML
are all relative:

<link rel="stylesheet" href="_static/typo3sphinx.css" type="text/css" />

<ul class="this-page-menu">
    <li><a href="../../_sources/Introduction/Screenshots/Index.txt"
           rel="nofollow">Show Source</a></li>

<p><a class="reference internal"
href="../../_images/mod1_overview.png"><img alt="Overview of the Backend
module to build Sphinx projects" src="../../_images/mod1_overview.png"
style="width: 500px;" /></a></p>

so as long as you keep the generated structure "intact", it will work.
Of course if you want to move directories around, you'll have to rewrite
all links.

BTW, it's exactly what I do when using EXT:sphinx and rendering as
"static": I render the doc into typo3temp/ and then move it to
typo3conf/Documentation, so yet another reason to ensure you that it
works :)

Kind regards

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