pvx Documentation Contribution Contract

Generated from commit 35e9761 (commit date: 2026-05-25T08:14:42-04:00).

Any code change that affects behavior, parameters, algorithms, windows, outputs, or references must update generated documentation in the same PR.

Required in Every Relevant PR

1. Regenerate source docs:

python3 scripts/scripts_generate_python_docs.py
python3 scripts/scripts_generate_theory_docs.py
python3 scripts/scripts_generate_docs_extras.py

2. Regenerate generated site/man outputs only when the change affects them:

python3 scripts/scripts_generate_html_docs.py
python3 scripts/scripts_install_man_pages.py

3. Ensure no doc drift remains (ignoring commit-stamp lines): git diff --exit-code -I '^_Generated from commit' -I '^% Auto-generated by scripts/scripts_generate_docs_extras.py from commit' -I 'Generated by <code>scripts/scripts_generate_html_docs.py</code> from commit' after generation.
4. Keep README links and algorithm inventories consistent with generated docs.
5. Expand each acronym on first use (for example, command-line interface (CLI), digital signal processing (DSP), short-time Fourier transform (STFT)).
6. If CLI flags changed, verify docs/CLI_FLAGS_REFERENCE.md and tests/test_docs_coverage.py pass.
7. If bibliography changed, regenerate docs/references.bib and docs/CITATION_QUALITY.md.

PR Checklist

• Code changes reflect intended behavior.
• Documentation regenerated.
• Acronyms are expanded on first use in updated docs.
• Tests pass (including docs coverage checks).
• New parameters or windows are mathematically documented.
• New references include DOI/publisher URLs when available.

Attribution

See ATTRIBUTION.md.