Skip to content

prkumar/sphinx-reload

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sphinx-Reload

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

About

Live preview your Sphinx documentation

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages