sphinxcontrib-gravatar is a Sphinx extension for Gravatar
Features
Provide gravatar icon for your document.
Set up
Make environment with pip:
$ pip install sphinxcontrib-gravatar
Usage
setup conf.py with:
# set extension
extensions += ['sphinxcontrib.gravatar']
# define gravatar users
gravatar_users = (
('tell-k', {'email': 'ffk2005@gmail.com' }),
)
write gravatar role:
.. gravatar:: tell-k # If you wanted to write in the text. you can use "Substitution References". .. |tell-k-gravatar| gravatar:: tell-k my gravatar image |tell-k-gravatar|.
and run:
$ make html
Option
TODO more documented.
conf.py options:
gravatar_default_size = 30
gravatar_default_image = "http://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50"
gravatar_default_rating = "pg"
gravatar_default_target = "http://github.com/tell-k/"
gravatar_force_default = True
gravatar_force_refresh = True
gravatar_unlink = True
gravatar_default_class = "custom-classname"
gravatar_users = (
('tell-k', {
'email': 'ffk2005@gmail.com',
'default': 'http://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50',
'force_default': True,
'unlink': True,
'target': "http://github.com/tell-k/",
'rating': "pg",
'class': u"custom-classname",
'alt': "alternative text",
}),
)
Directive options:
.. gravatar:: tell-k :size: 200 :default: mm :target: http://github.com/tell-k :rating: pg :class: test-gravatar :alt: altnativetext
Requirement
Python 2.7 or later.
Sphinx 1.2.x or later.
Using
License
sphinxcontrib-gravatar Licensed under the BSD License.
See the LICENSE file for specific terms.
History
0.1.2(Jan 1, 2015)
Exclude test code from installed packages
0.1.1(Dec 31, 2014)
Drop Python-3.2 support. #1
Support wheel format.
0.1.0(Oct 2, 2014)
First release
Metadata
Release files for sphinxcontrib-gravatar 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 |
|---|---|---|---|---|
| sphinxcontrib-gravatar-0.1.2.tar.gz | 16.1 kB | Without provenance | Details for sphinxcontrib-gravatar-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinxcontrib_gravatar-0.1.2-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for sphinxcontrib_gravatar-0.1.2-py2.py3-none-any.whl |
Total release size: 24.9 kB
Release files / sphinxcontrib-gravatar-0.1.2.tar.gz
| Download URL | sphinxcontrib-gravatar-0.1.2.tar.gz |
|---|---|
| Size | 16.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8dd2f77cdf05422c23547cd71fabfd46a62919e994037a799293e2bc73410233
|
|
BLAKE2b-256 checksum How to use checksums |
d26347f30054fd4ea444d0c29262eb7bad47d8b5b20a08279ad41edbb45bea04
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinxcontrib_gravatar-0.1.2-py2.py3-none-any.whl
| Download URL | sphinxcontrib_gravatar-0.1.2-py2.py3-none-any.whl |
|---|---|
| Size | 8.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
b10f31885eef2a1375778cdcac807a17704f8f8a77436db20305b1bd58ecc19e
|
|
BLAKE2b-256 checksum How to use checksums |
9fa41320de929a67f71484214208a98caaed82032c99ed9ac23f8aaedfe1609b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinxcontrib-gravatar 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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.