Sphinx extension with theme to generate Reveal.js presentation
Project description
Sphinx extension with theme to generate Reveal.js presentation
Overview
This extension generate Reveal.js presentation from standard reStructuredText.
It include theses features.
Custom builder to translate from reST to reveal.js style HTML
Template to be enable to render presentation local independent
For more information, refer to the documentation.
Installation
$ pip install sphinx-revealjsUsage
Create your sphinx documentation
Edit conf.py to use this extension
extensions = [ 'sphinx_revealjs', ]Write source for standard document style
Build sources as Reveal.js presentation
$ make revealjs
Change logs
See it
Policy for following to Reveal.js version
This is implemented based Reveal.js. I plan to update it at patch-version for catch up when new Reveal.js version released.
If Reveal.js updated minor or patch version, sphinx-revealjs update patch version.
If Reveal.js updated major version, sphinx-revealjs update minor version with compatible for two versions.
Contributing
GitHub repository does not have reveal.js library.
If you use from GitHub and editable mode, Run tools/fetch_revealjs.py after install.
$ git clone https://github.com/attakei/sphinx-revealjs
$ cd sphinx-revealjs
$ python tools/fetch_revealjs.pyFor more information, See CONTRIBUTING.rst and “contributing” page in documentation.
Copyright
Apache-2.0 license. Please see LICENSE.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_revealjs-3.2.1.tar.gz.
File metadata
- Download URL: sphinx_revealjs-3.2.1.tar.gz
- Upload date:
- Size: 4.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f76094f0ae41fea083adebb2d7a981561b8ce30b9b80496945aa8619442bbd8d
|
|
| MD5 |
39b00da58e915253b03673cf234f8f40
|
|
| BLAKE2b-256 |
0d45bb041a1d8df09c05997aaede986140bc14c9abc1f9026015b1efeabda94a
|
File details
Details for the file sphinx_revealjs-3.2.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_revealjs-3.2.1-py3-none-any.whl
- Upload date:
- Size: 2.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
805bed3ca459346e0f01967d5ed1c40d6b7b917de1541e1e4566c8341fe7017b
|
|
| MD5 |
4e2ff5969695e5867bcdb1d558ef6575
|
|
| BLAKE2b-256 |
acbb8df8c5f2f4dcd036afa43cb07e5584856e3d915591440f5e91abcdb04dec
|
