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.

Generating the documentation as JSON¶

When kickstarting a project, Sphinx creates a Makefile with different output. Generating your documentation is just a matter of running:

$ cd /path/to/documentation
$ make json

The documentation will be created in a json directory within the build (or _build) directory. This json directory is what should be published to your TYPO3 website, typically somewhere within fileadmin/.

Tip

Instead of manually setting up a Sphinx environment on your computer, you may consider using TYPO3 extension Sphinx available off TER.