Skip to main content

Helper CLI for Sphinx to realtime build

Project description

This is CLI tool for Documentation eXperimence with Sphinx.


sphinx-watch provides these features for user local environment.

  • Build document of Sphinx when source files are changed by users

  • HTTP server to publish built documentation using http.server


Uploaded PyPI

pip install sphinx-watch


Build only

sphinx-watch source build html

Run HTTP server

sphinx-watch source build html --http

Specify port by running HTTP server

sphinx-watch source build html --http --port 8080


This uses poetry and pre-commit

git clone
cd sphinx-watch
poetry install
pre-commit install


Apache License 2.0

Download files

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

Source Distribution

sphinx-watch-0.1.2.tar.gz (9.5 kB view hashes)

Uploaded source

Built Distribution

sphinx_watch-0.1.2-py2.py3-none-any.whl (8.4 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page