Skip to main content

sphinx-presentations

sphinx-presentations is a Sphinx extension to convert documentation to Reveal.js presentations.

Installation

python -m pip install sphinxext-presentations

Usage

Add sphinxext.presentations to your extensions list in your conf.py

extensions = [
   "sphinxext.presentations",
]

Presentations will launch when ?present is appended to the url of a page. It is recommended to add a way for viewers to launch presentations without modifying the url (a button perhaps?).

Building js assets

Installing dependencies

npm install

Building js

npx webpack

Metadata

Release files for sphinxext-presentations 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxext-presentations 0.3.1
File Size Uploaded
sphinxext_presentations-0.3.1.tar.gz 43.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinxext-presentations 0.3.1
File Interpreter ABI Platform
sphinxext_presentations-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 86.2 kB

Release files / sphinxext_presentations-0.3.1.tar.gz

Download URL sphinxext_presentations-0.3.1.tar.gz
Size 43.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0698f7fdf30b484ec7d37e4f3e752c004481c21e9ce9e6144265217bfb742e00
BLAKE2b-256 checksum
How to use checksums
b4abaa9b5e5c0af435580e93f1c5039fc5609206bd38b0b07d51a252cc487ed5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.19

Release files / sphinxext_presentations-0.3.1-py3-none-any.whl

Download URL sphinxext_presentations-0.3.1-py3-none-any.whl
Size 42.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
978c9dd6dd54f5a5f0c85f6f2ab0a43c4d96fadca93288102323ff84a353de6d
BLAKE2b-256 checksum
How to use checksums
8abe7e66cd776a8cce3d3d33f5f406f60bcf9cad5d6a2c2e9d6038d3509ce43b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.19

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page