34 lines
934 B
ReStructuredText
34 lines
934 B
ReStructuredText
Testing
|
|
========
|
|
|
|
Fast checks
|
|
-----------
|
|
|
|
Run the workspace checks from the repository root:
|
|
|
|
.. code-block:: console
|
|
|
|
cargo fmt --all -- --check
|
|
cargo test --locked --workspace
|
|
cargo clippy --locked --workspace --all-targets -- -D warnings
|
|
|
|
Compatibility fixtures
|
|
----------------------
|
|
|
|
The tests/compat directory defines fixed-input, two-run comparisons. They
|
|
protect runtime equivalence while changes are made to traversal, storage, and
|
|
output code. The fixture manifest records only test inputs and comparison
|
|
scope; it does not describe a historical source baseline.
|
|
|
|
Documentation checks
|
|
--------------------
|
|
|
|
Install the documentation dependencies and build both local documentation
|
|
targets:
|
|
|
|
.. code-block:: console
|
|
|
|
python -m pip install -r docs/requirements.txt
|
|
sphinx-build -W --keep-going -b html docs/source docs/_build/html
|
|
sphinx-build -W --keep-going -b linkcheck docs/source docs/_build/linkcheck
|