Skip to main content

Sphinx "gravatar" extension

Project description

sphinxcontrib-gravatar is a Sphinx extension for Gravatar

travis downloads latest version license


  • 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

Project details

Download files

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

Source Distribution

sphinxcontrib-gravatar-0.1.2.tar.gz (16.1 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_gravatar-0.1.2-py2.py3-none-any.whl (8.8 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page