DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

RequirementsΒΆ

This extension requires the Python interpreter to be available on your web server and -- of course -- you need a documentation written in reStructuredText and as a Sphinx project.

Tip

This extension may automatically install and configure rst2pdf to build PDF. However, if you want better output, you should consider using LaTeX instead. Please read chapter Rendering PDF from reStructuredText for instructions.

The extension supports single directory projects:

/path/to/project/
|-- _build
|-- conf.py
`-- ...

separate source/build directory projects:

/path/to/project/
|-- build
`-- source
    |-- conf.py
    `-- ...

and TYPO3 documentation directory structure:

/path/to/project/
|-- ...
`-- _make
    |-- build
    `-- conf.py

The dashboard lets you quickly create new documentation projects based on the layout which fits you best.