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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinxcontrib_waterloo_docstrings-0.8.1.tar.gz.
File metadata
- Download URL: sphinxcontrib_waterloo_docstrings-0.8.1.tar.gz
- Upload date:
- Size: 45.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d0ed84ce4982dd89e45440d1d58a762b714a5f23eea2c5517ba99eef36b6fca1
|
|
| MD5 |
206030324f77ee054d613106e48f1ddb
|
|
| BLAKE2b-256 |
cd74d5823a86c25ae7d35b0748c41acc03beb71691c426aaeeb527cc745d9ff8
|
Provenance
The following attestation bundles were made for sphinxcontrib_waterloo_docstrings-0.8.1.tar.gz:
Publisher:
publish_pypi.yaml on uwe-at-sdv/sphinxcontrib_waterloo_docstrings
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinxcontrib_waterloo_docstrings-0.8.1.tar.gz -
Subject digest:
d0ed84ce4982dd89e45440d1d58a762b714a5f23eea2c5517ba99eef36b6fca1 - Sigstore transparency entry: 2270007347
- Sigstore integration time:
-
Permalink:
uwe-at-sdv/sphinxcontrib_waterloo_docstrings@f9849702197efe340e579c30379ccebf089cd14b -
Branch / Tag:
refs/heads/main - Owner: https://github.com/uwe-at-sdv
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_pypi.yaml@f9849702197efe340e579c30379ccebf089cd14b -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinxcontrib_waterloo_docstrings-0.8.1-py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_waterloo_docstrings-0.8.1-py3-none-any.whl
- Upload date:
- Size: 52.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b83ca436bbe4fa0412aac7ffac3c2612076947b788a2275e4ff55eb5e064b50d
|
|
| MD5 |
85ac3e7924048698d38c4d2cd9c8e6ef
|
|
| BLAKE2b-256 |
7b6c442945901595c7ae2f03e850fa365dd49ed5aed6e21e6b1dd8148be1030e
|
Provenance
The following attestation bundles were made for sphinxcontrib_waterloo_docstrings-0.8.1-py3-none-any.whl:
Publisher:
publish_pypi.yaml on uwe-at-sdv/sphinxcontrib_waterloo_docstrings
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinxcontrib_waterloo_docstrings-0.8.1-py3-none-any.whl -
Subject digest:
b83ca436bbe4fa0412aac7ffac3c2612076947b788a2275e4ff55eb5e064b50d - Sigstore transparency entry: 2270007692
- Sigstore integration time:
-
Permalink:
uwe-at-sdv/sphinxcontrib_waterloo_docstrings@f9849702197efe340e579c30379ccebf089cd14b -
Branch / Tag:
refs/heads/main - Owner: https://github.com/uwe-at-sdv
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_pypi.yaml@f9849702197efe340e579c30379ccebf089cd14b -
Trigger Event:
push
-
Statement type:
