Sphinx "gravatar" extension
Project description
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.0(Oct 2, 2014)
First release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for sphinxcontrib-gravatar-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 055665d3536345d4c2d7e3d6d11a22be0bb773124f8cdbdd3adc22d2f65c43e7 |
|
MD5 | 5e30b438dd76e15a8a8ddf4a87422101 |
|
BLAKE2b-256 | e03eefaa4b382068a3521b6a44c243a3bf30b9be6fe9cf2ccc03dffe55c7d5e2 |