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.

3rd-party plugins

This extension lets you activate a few 3rd-party plugins (that is, Sphinx extensions which are not an official part of Sphinx).

Each plugin typically comes with a dedicated documentation that you may read when installing them, within the Extension Manager.

This chapter describes the process of using such a plugin within your documentation with a few examples of plugins available as well on docs.typo3.org and as such suited for use within extension manuals.

Loading a plugin

In order to load a plugin, you need to add it to the list of extensions of configuration file conf.py. However, as this file does not exist when creating an extension manual, you should change configuration file Settings.yml instead as this file is used by docs.typo3.org (and this extension) to override default parameters:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
conf.py:
  copyright: 2013
  project: Sphinx Python Documentation Generator and Viewer
  version: 1.2
  release: 1.2.0
  extensions:
  - sphinx.ext.intersphinx
  - t3sphinx.ext.t3extras
  - t3sphinx.ext.t3tablerows
  - t3sphinx.ext.targets
  - sphinxcontrib.googlechart
  - sphinxcontrib.googlemaps
  - sphinxcontrib.slide
  - sphinxcontrib.youtube

Extension lines 7 to 10 should always be kept as this. Extension lines 11 to 14 are examples on how to load 3rd-party plugins for use in your document.

Examples

sphinxcontrib.googlechart

This is a Sphinx extension which render charts and graphs by using Google Chart.

Example:

.. piechart::
    :size: 400x200

    restdoc: 639
    sphinx: 553
    image_autoresize: 2261

Rendered:

sphinxcontrib.googlemaps

This is a Sphinx extension which embeds maps using Google Maps.

Example:

.. googlemaps::
    :latitude: 46.804994
    :longtitude: 7.153826

Rendered:

sphinxcontrib.slide

This is a Sphinx extension for embedding your presentation slides.

Example:

.. slide:: http://www.slideshare.net/xperseguers/typo3-meets-xliff-rest

Rendered:

sphinxcontrib.youtube

This is a Sphinx extension for embedding a YouTube video using its video ID.

Example:

.. youtube:: YeGqHMDT7R8

Rendered: