Live preview your Sphinx documentation
Project description
Installation
To install, use pip (or easy_install):
$ pip install sphinx-reload
The package installs the command-line program sphinx-reload:
$ sphinx-reload --version v0.2.0
Getting Started
To begin live previewing your documentation, simply pass the path of your documentation’s root as a command-line argument with sphinx-reload. Here’s an example assuming your documentation’s root is under the current directory and named docs:
$ sphinx-reload docs/
sphinx-reload will open a preview in a new tab of your favorite browser and watch for changes in your documentation’s source files (e.g., any reStructuredText files under the documentation’s root).
To view further usage details, use the script’s --help option:
$ sphinx-reload --help
Release history Release notifications
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size sphinx_reload-0.2.0-py3-none-any.whl (4.7 kB) | File type Wheel | Python version py3 | Upload date | Hashes View hashes |
| Filename, size sphinx-reload-0.2.0.tar.gz (3.5 kB) | File type Source | Python version None | Upload date | Hashes View hashes |
Close
Hashes for sphinx_reload-0.2.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0c184b990d4bc50cf14b2e6b6cf89ce4f88a2baa9b22e36ae4e2abcb8f3f44b6 |
|
| MD5 | 9654e65f6043b8850952586ce121057c |
|
| BLAKE2-256 | f4959351a63ce7fdaff1bd44b69aa14d6c36b5be5d1f76577c32d5d79430b8d5 |
