Skip to main content

Live preview your Sphinx documentation

Project description

PyPI Version Build Status

demo.gif

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

Project details


Download files

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

Files for sphinx-reload, version 0.2.0
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

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page