Sphinx-Contrib Waterloo Docstrings
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:
- https://uwe-at-sdv.github.io/sphinxcontrib_waterloo_docstrings/showcase/furo/
- https://uwe-at-sdv.github.io/sphinxcontrib_waterloo_docstrings/showcase/alabaster/
- https://uwe-at-sdv.github.io/sphinxcontrib_waterloo_docstrings/showcase/classic/
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",
]
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-waterloo-docstrings 0.8.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib_waterloo_docstrings-0.8.4.tar.gz | 47.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_waterloo_docstrings-0.8.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 101.9 kB
Release files / sphinxcontrib_waterloo_docstrings-0.8.4.tar.gz
| Download URL | sphinxcontrib_waterloo_docstrings-0.8.4.tar.gz |
|---|---|
| Size | 47.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
27b3fee18fb3930a3b33395574733d2d9852fbe807427854e6042ad5ee54fac7
|
|
BLAKE2b-256 checksum How to use checksums |
2792e5de8a67d694e01cf87be1022b7fc50aba940171fd0a93d7844cdc279262
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency logRelease files / sphinxcontrib_waterloo_docstrings-0.8.4-py3-none-any.whl
| Download URL | sphinxcontrib_waterloo_docstrings-0.8.4-py3-none-any.whl |
|---|---|
| Size | 54.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b2e58ab0a21d06b3bf47b55a907ed6719461f25b47fa1ef84865a5c759ce1408
|
|
BLAKE2b-256 checksum How to use checksums |
288f4c8c8174f6050a4dc8fde32a2f6c6df23cde0247657533042c27e182efaa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency log
