sphinx_revealjs.ext.oembed

Added in version 3.2.0.

Overview

This extension provide oEmbed content for presentation. You can embed presentation used this into your document by oembed directive of oEmbedPy.

Installation

You need not install extra, you can use it immediately after installing sphinx-revealjs.

Usage

Add extension module into extensions of your conf.py.

conf.py

extensions = [
    "sphinx_revealjs",
    "sphinx_revealjs.ext.oembed",
]

Configuration

All Configuration names are prefixed revealjs_oembed_.

revealjs_oembed_url

Type:

str

Default:

"http://localhost:8000"

Example:

"https://example.com"

Base part of URL for presentations and oEmbed contents.

Default value is to test in localmachine. We recommend to set for your environment.

revealjs_oembed_out_dir

Type:

str

Default:

"_files/oembed"

Example:

"_static/oembed"

Root directory of destination for oEmbed contents.

revealjs_oembed_excludes

Type:

list[str]

Default:

[] (empty list)

Example:

["index"]

List of docname that you don’t want to generate oEmbed contents.