sdv-doc-waterloo 0.10.0

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"

Sitemap

Branch gh-pages

• Human-readable documentation
  • https://...

Branch ide-plugins

• Additional utilities
  • Clone directly:
    • git clone --branch ide-plugins --single-branch https://github.com/uwe-at-sdv/sdv_doc_waterloo.git
  • Lexer for pygments
    • pygments/python_waterloo_lexer.py
  • Extension for vscode
    • Waterloo syntax highlighting
    • Context menu commands for docstring generation and validation

Branch main

• Machine-readable documentation

  • src/sdv/doc/waterloo/doc-json/docitem.wtrl.*.*.json
  • src/sdv/doc/waterloo/doc-json/docitem_sphinx.wtrl.*.*.json

• JSON-Schema

  • src/sdv/doc/waterloo/schema/wtrl-*-json-*.*.*.schema.json

• Public modules:

  • src/sdv/doc/waterloo/docitem_helper.py
  • src/sdv/doc/waterloo/docitem_convert.py
  • src/sdv/doc/waterloo/docitem_sphinx.py

• Change logs:

  • src/sdv/doc/waterloo/docitem.py following the definition of __version__
  • src/sdv/doc/waterloo/waterlint.py following the definition of __version__