DEPRECATION WARNING

This documentation is not using the current rendering mechanism and will be deleted by December 31st, 2020. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

Render a reST documentation

The easiest way to render a documentation for your extension is:

  1. Install the sphinx and the restdoc extensions
  2. Follow the instructions in the video at Sphinx documentation
  3. Rename the Documentation.tmpl/ folder generated by the extension builder to Documentation/
  4. Adapt the reST files to your extension: Remove unused files, modify existing ones and/or create new files
  5. Go to the Spinx Documentation Link in the Help section in the backend and select your extension
  6. Select “interactive” as layout to see how your documentation will be displayed on typo3.org (don’t forget to check the “Always render documentation” when you modified the reST files)