Skip to main content

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-watch

Usage

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

Development

This uses poetry and pre-commit

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

License

Apache License 2.0

Metadata

Release files for sphinx-watch 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-watch 0.1.2
File Size Uploaded
sphinx-watch-0.1.2.tar.gz 9.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-watch 0.1.2
File Interpreter ABI Platform
sphinx_watch-0.1.2-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 17.9 kB

Release files / sphinx-watch-0.1.2.tar.gz

Download URL sphinx-watch-0.1.2.tar.gz
Size 9.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a83ab7c81c857305faf55a55969f2df65a071e199031bad3a4a37346dbba2d24
BLAKE2b-256 checksum
How to use checksums
b6a45e7d64f25b2bd644603bb0a11380204b50ffaf1890dcd7befbaf4b01cff6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Release files / sphinx_watch-0.1.2-py2.py3-none-any.whl

Download URL sphinx_watch-0.1.2-py2.py3-none-any.whl
Size 8.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a17df2a507d679b084e3c9022ee124325701b43f78f51f9e5ede172124d09faa
BLAKE2b-256 checksum
How to use checksums
a3d34478249ea259efe2849c64d3d8048bd46b278a8d61cb734f438f7ac328e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page