https://img.shields.io/pypi/v/sphinx-revealjs.svg https://github.com/attakei/sphinx-revealjs/actions/workflows/main.yml/badge.svg Documentation Status

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-revealjs

Usage

  1. Create your sphinx documentation

  2. Edit conf.py to use this extension

    extensions = [
    'sphinx_revealjs',
]

  3. Write source for standard document style

  4. 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.py

For more information, See CONTRIBUTING.rst and “contributing” page in documentation.

Copyright

Apache-2.0 license. Please see LICENSE.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for attakei from gravatar.com attakei

Credits

Author: Kazuya Takei

License

Apache Software License

Requires

Python >=3.9

Provides Extra

screenshot

Classifiers

Report project as malware

Release files for sphinx-revealjs 3.2.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 sphinx-revealjs 3.2.1
File Size Uploaded
sphinx_revealjs-3.2.1.tar.gz 4.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-revealjs 3.2.1
File Interpreter ABI Platform
sphinx_revealjs-3.2.1-py3-none-any.whl 2.4 MB Python 3 none any Details

Total release size: 6.4 MB

Release files / sphinx_revealjs-3.2.1.tar.gz

Download URL sphinx_revealjs-3.2.1.tar.gz
Size 4.0 MB
Tags Source
SHA-256 checksum
How to use checksums 		f76094f0ae41fea083adebb2d7a981561b8ce30b9b80496945aa8619442bbd8d
BLAKE2b-256 checksum
How to use checksums 		0d45bb041a1d8df09c05997aaede986140bc14c9abc1f9026015b1efeabda94a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / sphinx_revealjs-3.2.1-py3-none-any.whl

Download URL sphinx_revealjs-3.2.1-py3-none-any.whl
Size 2.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums 		805bed3ca459346e0f01967d5ed1c40d6b7b917de1541e1e4566c8341fe7017b
BLAKE2b-256 checksum
How to use checksums 		acbb8df8c5f2f4dcd036afa43cb07e5584856e3d915591440f5e91abcdb04dec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

3.2.1 This release

2 release files

3.2.0

2 release files

3.1.4

2 release files

3.1.3

2 release files

3.1.2

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.5

2 release files

3.0.4

2 release files

3.0.3

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.9.3

2 release files

2.9.2

2 release files

2.9.1

2 release files

2.9.0

2 release files

2.8.0

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.0

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

Pre-release

2.0.0b3

2 release files

Pre-release

2.0.0b2

2 release files

Pre-release

2.0.0b1

2 release files

Pre-release

2.0.0.dev2

2 release files

Pre-release

2.0.0.dev1

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.6

2 release files

1.4.5

2 release files

1.4.4

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

Pre-release

1.0.0b3

2 release files

Yanked

1.0.0b2

2 release files

Yanked reason: Old reveal.js bundled

Pre-release

1.0.0b1

2 release files

0.12.1

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.10.1

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

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