https://github.com/prkumar/sphinx-reload
Live preview your Sphinx documentation
https://github.com/prkumar/sphinx-reload
python sphinx
Last synced: 12 months ago
JSON representation
Live preview your Sphinx documentation
- Host: GitHub
- URL: https://github.com/prkumar/sphinx-reload
- Owner: prkumar
- License: mit
- Created: 2017-10-12T03:46:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T10:35:42.000Z (about 3 years ago)
- Last Synced: 2025-03-26T16:55:04.840Z (12 months ago)
- Topics: python, sphinx
- Language: Python
- Homepage:
- Size: 17.5 MB
- Stars: 47
- Watchers: 2
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Sphinx-Reload
*************
|PyPI Version| |Build Status|
.. image:: 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
.. |Build Status| image:: https://travis-ci.org/prkumar/sphinx-reload.svg?branch=master
:target: https://travis-ci.org/prkumar/sphinx-reload
.. |PyPI Version| image:: https://img.shields.io/pypi/v/sphinx-reload.svg
:target: https://pypi.python.org/pypi/sphinx-reload