sphinx-related-links
sphinx-related-links adds functionality to Sphinx that allows adding related links on a per-page basis, supporting both Discourse topic links and custom related URLs.
Basic usage
Adding Discourse links
Configure the Discourse prefix in your conf.py:
html_context = {
"discourse_prefix": "https://discuss.linuxcontainers.org/t/"
}
html_context = {
"discourse_prefix": {
"ubuntu": "https://discourse.ubuntu.com/t/",
"lxc": "https://discuss.linuxcontainers.org/t/"
}
}
Add the desired Discourse topic IDs to the page's metadata. For MyST files, this is done with frontmatter.
---
discourse: 12033,13128
---
For rST sources, metadata content can be added with the following syntax:
:discourse: 12033, 13128
Adding custom related links
Add URLs to page metadata:
---
relatedlinks: https://www.example.com, https://www.google.com
---
Project setup
sphinx-related-links is published on PyPI and can be installed with:
pip install sphinx-related-links
After adding sphinx-related-links to your Python project, update your Sphinx's conf.py file to include sphinx-related-links as one of its extensions:
extensions = [
"sphinx_related_links"
]
Lastly, update your Sphinx project's templates to include the metadata content in the right-hand sidebar. This will depend on your project's theme. An example template can be seen in this project's integration tests.
Community and support
You can report any issues or bugs on the project's GitHub repository.
sphinx-related-links is covered by the Ubuntu Code of Conduct.
License and copyright
sphinx-related-links is released under the GPL-3.0 license.
© 2025 Canonical Ltd.
Release files for sphinx-related-links 0.1.2
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_related_links-0.1.2.tar.gz | 84.2 kB | With provenance | Details for sphinx_related_links-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_related_links-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for sphinx_related_links-0.1.2-py3-none-any.whl |
Total release size: 104.1 kB
Release files / sphinx_related_links-0.1.2.tar.gz
| Download URL | sphinx_related_links-0.1.2.tar.gz |
|---|---|
| Size | 84.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7e4951f4fa60b21e0806dda53db41be565b589e22b58cc18d09c2676a49d00ca
|
|
BLAKE2b-256 checksum How to use checksums |
9194f46c27a759b9c1f489ae18710ea2b5c1610d486586a8499d88c32be79040
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Dec 15, 2025.
Transparency logRelease files / sphinx_related_links-0.1.2-py3-none-any.whl
| Download URL | sphinx_related_links-0.1.2-py3-none-any.whl |
|---|---|
| Size | 19.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0f894cff31f330aa0fbbfb2d6cccc0bc07153a56925427d9f3dc4a1d9b0e08eb
|
|
BLAKE2b-256 checksum How to use checksums |
3dbd6971dde17d8f1446a1b52d22d3b937df8f7fd380b94d109c3d9e3f2bfd62
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Dec 15, 2025.
Transparency logSecurity for sphinx-related-links 0.1.2
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_related_links-0.1.2.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 Dec 15, 2025.
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.
