Overview

The sphinx-revealjs extension provides a seamless way to create stunning presentations using Reveal.js directly from reStructuredText (reST). Ideal for Pythonista users, this tool transforms standard documentation into visually engaging presentations without extensive formatting hassle.

Key Features

• Custom Builder: The extension includes a custom builder that translates reStructuredText documents into Reveal.js formatted HTML, enabling straightforward presentation creation.
• Independent Templates: Users can leverage templates that allow for local-independent rendering of presentations, making it easier to manage and customize outputs.

For comprehensive guidance, visit the documentation.

Getting Started

To integrate the sphinx-revealjs extension into your project:

1. Set up your Sphinx documentation.

2. Modify the conf.py configuration file to include the extension:

   extensions = [
       'sphinx_revealjs',
   ]
   

3. Create your content in the standard document style.

4. Build your sources as a Reveal.js presentation:

   $ make revealjs
   

Version Compatibility

The extension is developed to closely follow the updates to Reveal.js. Planned update protocols include:

• Patch updates for minor or patch version changes in Reveal.js.
• Minor version updates of sphinx-revealjs for any major changes, ensuring compatibility with both the new and previous versions.

Contribution Guidelines

While the GitHub repository does not host the Reveal.js library, developers can fetch it using the provided script after installation. After cloning the repository, run:

$ python tools/fetch_revealjs.py

For thorough details on how to contribute, refer to the CONTRIBUTING.rst file or visit the contributing guide.

This extension enhances the presentation creation workflow for Python developers, making it easier to communicate ideas effectively.