sphinx-roles
sphinx-roles contains the literalref and spellexception roles.
Basic usage
literalref
To add a monospaced reference to your document, pass the target or URL to the
literalref role:
:literalref:`link text <ref-target>`
:literalref:`link text <https://example.com>`
spellexception
To exempt a string from spell checking, wrap it in the spellexception role:
:spellexception:`Lorem ipsum`
Project setup
sphinx-roles is published on PyPI and can be installed with:
pip install sphinx-roles
After adding sphinx-roles to your Python project, update your Sphinx's conf.py
file to include sphinx_roles as an extension:
extensions = [
"sphinx_roles"
]
Community and support
You can report any issues or bugs on the project's GitHub repository.
sphinx-roles is covered by the Ubuntu Code of Conduct.
License and copyright
sphinx-roles is released under the GPL-3.0 license.
© 2025 Canonical Ltd.
Release files for sphinx-roles 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_roles-1.0.0.tar.gz | 101.4 kB | With provenance | Details for sphinx_roles-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_roles-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for sphinx_roles-1.0.0-py3-none-any.whl |
Total release size: 119.0 kB
Release files / sphinx_roles-1.0.0.tar.gz
| Download URL | sphinx_roles-1.0.0.tar.gz |
|---|---|
| Size | 101.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d3687db93bc9d49a04653b4e1399e9d77f8291ca083d284e95d1779f0c467662
|
|
BLAKE2b-256 checksum How to use checksums |
38b0273ca3d5e8b38d8b6d4e3f9db85ebd46c4825ead4cb69de207032913581a
|
| 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 Oct 1, 2026.
Transparency logRelease files / sphinx_roles-1.0.0-py3-none-any.whl
| Download URL | sphinx_roles-1.0.0-py3-none-any.whl |
|---|---|
| Size | 17.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d720a8f45e9b0117fa95d4b1762122ddac3ddfdcd82b5693513d084d5e82ea36
|
|
BLAKE2b-256 checksum How to use checksums |
93dd56f1c292cc4b2f5709968bdbfd5bf38984c3010fabfa1ac77e1bbc452f6d
|
| 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 Oct 1, 2026.
Transparency logSecurity for sphinx-roles 1.0.0
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for sphinx_roles-1.0.0.tar.gz
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 Oct 1, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
