sdv-doc-waterloo 0.10.1

Waterloo - Docstring Format and Tools

PRELIMINARY - OFFICIAL START AT 2026-07-01

README

Install

package_main contains the Waterloo Python package and the Sphinx extension. The package can be installed from a local checkout of this repository:

cd package_main
pip install .

For development, an editable install is often more convenient:

cd package_main
pip install -e .

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

cd package_main
pip install ".[sphinx]"

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"