Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Sphinx "gravatar" extension

Project Description

sphinxcontrib-gravatar is a Sphinx extension for Gravatar


  • Provide gravatar icon for your document.

Set up

Make environment with pip:

$ pip install sphinxcontrib-gravatar


setup with:

# set extension
extensions += ['sphinxcontrib.gravatar']

# define gravatar users
gravatar_users = (
    ('tell-k', {'email': '' }),

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


TODO more documented. options:

gravatar_default_size = 30
gravatar_default_image = ""
gravatar_default_rating = "pg"
gravatar_default_target = ""
gravatar_force_default = True
gravatar_force_refresh = True
gravatar_unlink = True
gravatar_default_class = "custom-classname"

gravatar_users = (
    ('tell-k', {
        'email': '',
        'default': '',
        'force_default': True,
        'unlink': True,
        'target': "",
        'rating': "pg",
        'class': u"custom-classname",
        'alt': "alternative text",

Directive options:

.. gravatar:: tell-k
   :size: 200
   :default: mm
   :rating: pg
   :class: test-gravatar
   :alt: altnativetext


  • Python 2.7 or later.
  • Sphinx 1.2.x or later.



  • sphinxcontrib-gravatar Licensed under the BSD License.

See the LICENSE file for specific terms.


  • tell-k <ffk2005 at>


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
Release History

Release History

This version
History Node


History Node


History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib_gravatar-0.1.2-py2.py3-none-any.whl (8.8 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Jan 1, 2015
sphinxcontrib-gravatar-0.1.2.tar.gz (16.1 kB) Copy SHA256 Checksum SHA256 Source Jan 1, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting