Waterloo Logo

Sphinx-Contrib Waterloo Docstrings

License Version Python Sphinx WTRL GitHub

Project Status

The project is under development, but seems to do what it is supposed to do. Feel free to dowload and try out.

About

The sphinxcontrib-waterloo-docstrings package provides the Sphinx rendering layer for Waterloo Docstrings.

Waterloo Docstrings define a structured docstring format with explicit section semantics, normativity rules, and machine-readable output layers. This package connects that format to Sphinx by providing roles, directives, and rendering helpers for documentation projects that want to present Waterloo docstrings as human-readable HTML.

The extension is intentionally theme-friendly. It lets Sphinx themes such as Furo, Alabaster, and Classic provide most of the final layout, while the extension supplies semantic CSS classes for Waterloo roles and generated documentation structures.

What it provides

  • Sphinx roles for Waterloo inline markup.
  • Directives for rendering modules, classes, functions, methods, and context scopes.
  • Static CSS for Waterloo semantic roles.
  • Theme showcase sources for Furo, Alabaster, and Classic.

Related packages

  • sdv-doc-waterloo: core parser, validator, renderer, waterlint, and MCP server.
  • python-waterloo-lexer: Pygments lexer for Python files with Waterloo docstrings.

Documentation showcase

The Sphinx extension documentation is published at:

The Sphinx extension showcase is published under:

Installation

Install the Sphinx extension from PyPI:

pip install sphinxcontrib-waterloo-docstrings

The package depends on sdv-doc-waterloo and provides the Sphinx integration layer for Waterloo Docstrings.

Quick check

After installation, add the extension to a Sphinx conf.py:

extensions = [
    "sphinxcontrib.waterloo_docstrings",
]

Project links

Data verified by PyPI on Jul 27, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.8.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for uwe-at-sdv from gravatar.com uwe-at-sdv

Credits

Author: Uwe

GitHub Statistics

Data verified by PyPI on Jul 27, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

BSD-2-Clause
View SPDX License List

Requires

Python >=3.10

Provides Extra

sphinx

Tags

docstrings documentation normativity sphinx waterloo

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib_waterloo_docstrings-0.8.0.tar.gz (44.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinxcontrib_waterloo_docstrings-0.8.0-py3-none-any.whl (51.0 kB view details)

Uploaded Python 3

File details

Details for the file sphinxcontrib_waterloo_docstrings-0.8.0.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib_waterloo_docstrings-0.8.0.tar.gz
Algorithm Hash digest
SHA256 91bbc735f94918c50c6a4cf3f45a5fe2f816d67fbaf856adb2819a8a55e596b2
MD5 3180b179619062ba80ed20a682067e60
BLAKE2b-256 7aa48d4021110d5a07f1445b4cb6452a493ceed4c186e035f3a65dc6de1ea8ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_waterloo_docstrings-0.8.0.tar.gz:

Publisher: publish_pypi.yaml on uwe-at-sdv/sphinxcontrib_waterloo_docstrings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinxcontrib_waterloo_docstrings-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_waterloo_docstrings-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 776f7adf2151aead81fcac73f1b9f3c971688fc59d3f3e35bcf6024e03128669
MD5 4b178019cbb5a45d5cb93b4b89888759
BLAKE2b-256 e5fd3cb29d538a523561030594e462e487ed60dd73f797f6ada92800eac10156

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_waterloo_docstrings-0.8.0-py3-none-any.whl:

Publisher: publish_pypi.yaml on uwe-at-sdv/sphinxcontrib_waterloo_docstrings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.8.2

2 files

0.8.1

2 files

This release

0.8.0 This release

2 files

0.7.15

2 files

0.7.14

2 files

0.7.13

2 files

0.7.12

2 files

0.7.11

2 files

0.7.10

2 files

0.7.9

2 files

0.7.8

2 files

0.7.7

2 files

0.7.6

2 files

0.7.5

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page