https://github.com/wpilibsuite/sphinxext-presentations
Sphinx extension to present documentation
https://github.com/wpilibsuite/sphinxext-presentations
Last synced: about 1 month ago
JSON representation
Sphinx extension to present documentation
- Host: GitHub
- URL: https://github.com/wpilibsuite/sphinxext-presentations
- Owner: wpilibsuite
- License: other
- Created: 2022-01-02T18:41:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T03:31:37.000Z (9 months ago)
- Last Synced: 2025-04-14T12:06:24.662Z (about 1 month ago)
- Language: TypeScript
- Size: 214 KB
- Stars: 2
- Watchers: 7
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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`
```python
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
```