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
1 maintainer
Metadata
1 maintainer
Release files for sphinx-reload 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx-reload-0.2.0.tar.gz | 3.5 kB | Without provenance | Details for sphinx-reload-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_reload-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for sphinx_reload-0.2.0-py3-none-any.whl |
Total release size: 8.2 kB
Release files / sphinx-reload-0.2.0.tar.gz
| Download URL | sphinx-reload-0.2.0.tar.gz |
|---|---|
| Size | 3.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
800e07bffea6de0e4ee5f9c14ef565ba1d0343c4a516d028e978bbcaf712fa07
|
|
BLAKE2b-256 checksum How to use checksums |
9e0ccc638554fbb12066329aff959e6cd0dc24797c3de878326d0decd8c366f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.3
|
Release files / sphinx_reload-0.2.0-py3-none-any.whl
| Download URL | sphinx_reload-0.2.0-py3-none-any.whl |
|---|---|
| Size | 4.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0c184b990d4bc50cf14b2e6b6cf89ce4f88a2baa9b22e36ae4e2abcb8f3f44b6
|
|
BLAKE2b-256 checksum How to use checksums |
f4959351a63ce7fdaff1bd44b69aa14d6c36b5be5d1f76577c32d5d79430b8d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.3
|
Security for sphinx-reload 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
