wpilibsuite / sphinxext-presentations

Sphinx extension to present documentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

Sphinx extension to present documentation

License:Other


Languages

Language:TypeScript 85.7%Language:JavaScript 9.3%Language:Python 5.0%