🧪 shtest
shtest tests shell commands in your Sphinx documentation. The shtest directive supports the usual doctest syntax. It offers the following options:
:returncode: [integer]specifies the expected return code (defaults to 0).adding the
:stderr:flag compares results with thestderrrather thanstdoutstream.:cwd: [relative path]specifies the working directory relative to the source of the document (defaults to the directory containing the source document).:tempdir:executes the test in a temporary directory.
Examples
# Obligatory hello world example.
$ echo hello world
hello world
:stderr:
# Read from stderr instead of stdout.
$ echo message on stderr >&2
message on stderr
:returncode: 1
# Use a non-zero expected return code.
$ false
# Run multiple tests in one directive.
$ echo hello
hello
$ echo world
world
:cwd: tests
# Run a test in a particular working directory relative to the document.
$ cat hello.txt
world
:tempdir:
# Run a test in a temporary directory.
$ echo hello > world.txt
Installation
Run pip install sphinxcontrib-shtest to install the package and add "sphinxcontrib.shtest" to your extensions list in conf.py (see here for details). Then execute sphinx-build -b shtest /path/to/source/directory /path/to/output/directory.
Metadata
Release files for sphinxcontrib-shtest 0.5.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 |
|---|---|---|---|---|
| sphinxcontrib-shtest-0.5.0.tar.gz | 5.3 kB | Without provenance | Details for sphinxcontrib-shtest-0.5.0.tar.gz |
Release files / sphinxcontrib-shtest-0.5.0.tar.gz
| Download URL | sphinxcontrib-shtest-0.5.0.tar.gz |
|---|---|
| Size | 5.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
65753c0ae0869ccfac53218cb491a253cd3965e730b74496c65c8938975cfafc
|
|
BLAKE2b-256 checksum How to use checksums |
c0f06a4deed6434d9fc80ed33069b51895cfb9ac1eb2d3f578493beb3645360f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.3
|
Security for sphinxcontrib-shtest 0.5.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.