sdv-doc-waterloo 0.10.5

Waterloo - Docstring Format and Tools

PRELIMINARY - OFFICIAL START AT 2026-07-01

README

On PyPI

sdv-doc-waterloo is the published PyPI package that contains the Waterloo Python package and the Sphinx extension.

Install it from PyPI:

pip install sdv-doc-waterloo

If you want to build the documentation with the Sphinx extension, install the optional extra that provides the external sphinx dependency:

pip install "sdv-doc-waterloo[sphinx]"

Development installs

If you prefer a local checkout, install from the repository tree:

cd package_main
pip install .

For active development, an editable install is often more convenient:

cd package_main
pip install -e .

The package can also be installed directly from Git:

pip install "git+https://github.com/uwe-at-sdv/sdv_doc_waterloo.git@main#subdirectory=package_main"

SSH works as well for authenticated access:

pip install "git+ssh://[e-mail]/uwe-at-sdv/sdv_doc_waterloo.git@main#subdirectory=package_main"

Source

The source repository for sdv-doc-waterloo is the Waterloo GitHub repository:

• https://github.com/uwe-at-sdv/sdv_doc_waterloo