Helper CLI for Sphinx to realtime build
Project description
This is CLI tool for Documentation eXperimence with Sphinx.
Overview
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
Installation
Uploaded PyPI
pip install sphinx-watchUsage
Build only
sphinx-watch source build htmlRun HTTP server
sphinx-watch source build html --httpSpecify port by running HTTP server
sphinx-watch source build html --http --port 8080Development
This uses poetry and pre-commit
git clone
cd sphinx-watch
poetry install
pre-commit installLicense
Apache License 2.0
Release history Release notifications | RSS feed
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 details)
Built Distribution
File details
Details for the file sphinx-watch-0.1.2.tar.gz.
File metadata
- Download URL: sphinx-watch-0.1.2.tar.gz
- Upload date:
- Size: 9.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a83ab7c81c857305faf55a55969f2df65a071e199031bad3a4a37346dbba2d24 |
|
| MD5 | bbbf4c5da8c9986d1aa1911e61677498 |
|
| BLAKE2b-256 | b6a45e7d64f25b2bd644603bb0a11380204b50ffaf1890dcd7befbaf4b01cff6 |
File details
Details for the file sphinx_watch-0.1.2-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_watch-0.1.2-py2.py3-none-any.whl
- Upload date:
- Size: 8.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a17df2a507d679b084e3c9022ee124325701b43f78f51f9e5ede172124d09faa |
|
| MD5 | 54f2c8ff93f525abe337ad228245f0e6 |
|
| BLAKE2b-256 | a3d34478249ea259efe2849c64d3d8048bd46b278a8d61cb734f438f7ac328e2 |
