sphinxcontrib-friendlinks
A Sphinx extension for rendering beautiful friend link cards in your documentation.
Installation
pip install sphinxcontrib-friendlinks
Usage
Add the extension to your conf.py:
extensions = [
'sphinxcontrib_friendlinks',
]
Then use the friendlink directive in your reStructuredText files:
.. friendlink::
:name: Example Site
:link: https://example.com
:avatar: https://example.com/avatar.png
:descr: This is an example site description
:siteshot: https://example.com/screenshot.png
:rss: https://example.com/rss.xml
Options
| Option | Required | Description |
|---|---|---|
name |
Yes | Site name |
link |
Yes | Site URL |
avatar |
Yes | Avatar image URL |
descr |
Yes | Site description |
siteshot |
No | Site screenshot URL |
rss |
No | RSS feed URL |
Features
- Clean card-style layout with avatar, name, description
- Optional site screenshot display
- RSS link with icon
- Responsive design for mobile devices
- Dark mode support (
prefers-color-scheme) - XSS protection for user input
Example
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-friendlinks 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 | |
|---|---|---|---|
| sphinxcontrib_friendlinks-0.1.2.tar.gz | 4.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_friendlinks-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.5 kB
Release files / sphinxcontrib_friendlinks-0.1.2.tar.gz
| Download URL | sphinxcontrib_friendlinks-0.1.2.tar.gz |
|---|---|
| Size | 4.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5f02f513a773fa2f31596c82016c1df7ca5ed6ce2bea0784dd1ada774e07e4e1
|
|
BLAKE2b-256 checksum How to use checksums |
21442377f6e20e757f484d6ab7196d8a5ca030c72d7b2f2f76d280e562c92d00
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / sphinxcontrib_friendlinks-0.1.2-py3-none-any.whl
| Download URL | sphinxcontrib_friendlinks-0.1.2-py3-none-any.whl |
|---|---|
| Size | 6.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3494b569e630a42aecba9583ddb6db2c37f1cb2dcbf53872cf344136a8e7ceb3
|
|
BLAKE2b-256 checksum How to use checksums |
b3897ffa092c93cc8a29d44fd61d991e551f4d99875c046bb3d1fbd95d0b18e7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
