sphinx-revealjs

Sphinx extension with theme to generate Reveal.js presentation

These details have not been verified by PyPI

Project links

Project description

https://img.shields.io/pypi/v/sphinx-revealjs.svg

https://github.com/attakei/sphinx-revealjs/actions/workflows/main.yml/badge.svg

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

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

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

Copyright

Apache-2.0 license. Please see LICENSE.

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

This version

3.2.0

Apr 3, 2025

3.1.4

Mar 22, 2025

3.1.3

Mar 9, 2025

3.1.2

Mar 9, 2025

3.1.1

Mar 1, 2025

3.1.0

Feb 27, 2025

3.0.5

Oct 19, 2024

3.0.4

Sep 15, 2024

3.0.3

Aug 18, 2024

3.0.2

May 6, 2024

3.0.1

Apr 14, 2024

3.0.0

Feb 26, 2024

2.9.3

Jan 13, 2024

2.9.2

Dec 2, 2023

2.9.1

Nov 25, 2023

2.9.0

Nov 19, 2023

2.8.0

Oct 29, 2023

2.7.1

Sep 29, 2023

2.7.0

Sep 29, 2023

2.6.0

Apr 30, 2023

2.5.1

Jan 6, 2023

2.5.0

Dec 18, 2022

2.4.1

Nov 20, 2022

2.4.0

Nov 13, 2022

2.3.0

Oct 23, 2022

2.2.0

Sep 30, 2022

2.1.0

Aug 27, 2022

2.0.1

Aug 2, 2022

2.0.0

Jun 16, 2022

2.0.0b3 pre-release

Jun 12, 2022

2.0.0b2 pre-release

Jun 1, 2022

2.0.0b1 pre-release

May 25, 2022

2.0.0.dev2 pre-release

May 23, 2022

2.0.0.dev1 pre-release

May 8, 2022

1.5.3

Jun 1, 2022

1.5.2

Apr 29, 2022

1.5.1

Apr 21, 2022

1.5.0

Apr 10, 2022

1.4.6

Mar 26, 2022

1.4.5

Mar 6, 2022

1.4.4

Dec 11, 2021

1.4.3

Nov 20, 2021

1.4.2

Nov 20, 2021

1.4.1

Nov 16, 2021

1.4.0

Nov 13, 2021

1.3.1

Jul 17, 2021

1.3.0

Jul 11, 2021

1.2.1

Jun 13, 2021

1.2.0

Jun 6, 2021

1.1.0

Apr 4, 2021

1.0.1

Jan 30, 2021

1.0.0

Jan 3, 2021

1.0.0b3 pre-release

Jan 1, 2021

1.0.0b2 pre-release yanked

Jan 1, 2021

Reason this release was yanked:

Old reveal.js bundled

1.0.0b1 pre-release

Dec 27, 2020

0.12.1

Dec 12, 2020

0.12.0

Jun 21, 2020

0.11.0

Apr 16, 2020

0.10.1

Apr 9, 2020

0.10.0

Mar 25, 2020

0.9.0

Dec 22, 2019

0.8.0

Nov 10, 2019

0.7.0

Oct 28, 2019

0.6.1

Sep 12, 2019

0.6.0

Jul 30, 2019

0.5.1

Jun 30, 2019

0.5.0

Dec 31, 2018

0.4.1

Dec 21, 2018

0.4.0

Dec 10, 2018

0.3.1

Nov 28, 2018

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_revealjs-3.2.0.tar.gz (4.0 MB view details)

Uploaded Apr 3, 2025 Source

Built Distribution

sphinx_revealjs-3.2.0-py3-none-any.whl (2.4 MB view details)

Uploaded Apr 3, 2025 Python 3

File details

Details for the file sphinx_revealjs-3.2.0.tar.gz.

File metadata

Download URL: sphinx_revealjs-3.2.0.tar.gz
Upload date: Apr 3, 2025
Size: 4.0 MB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sphinx_revealjs-3.2.0.tar.gz
Algorithm	Hash digest
SHA256	`3d1098eaf923b4c0d1f049ee8039b1e7ec55aac669461514f9edf0c2c517cc27`
MD5	`3a3b00f78a001303ddd5f2cb85d2496b`
BLAKE2b-256	`3c8e7d087365ff4f70fe665370c7542ef349c29d0988f2c2135983f13556f6c7`

See more details on using hashes here.

File details

Details for the file sphinx_revealjs-3.2.0-py3-none-any.whl.

File metadata

Download URL: sphinx_revealjs-3.2.0-py3-none-any.whl
Upload date: Apr 3, 2025
Size: 2.4 MB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sphinx_revealjs-3.2.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`0c19290687a68c835a4653c3e679528b64393731759dc72e8e5361367c5e41e9`
MD5	`2a99d47c060d59a639f97e881b1fe90c`
BLAKE2b-256	`f16f27d68997ed5de25445b151fd89cb968801ab355aaa8a3240793d44a77102`