Skip to main content

Sphinx "gravatar" extension

Project description

sphinxcontrib-gravatar is a Sphinx extension for Gravatar

travis coveralls.io downloads latest version license requires.io

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.

Authors

  • tell-k <ffk2005 at gmail.com>

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

Project details


Download files

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

Files for sphinxcontrib-gravatar, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_gravatar-0.1.2-py2.py3-none-any.whl (8.8 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size sphinxcontrib-gravatar-0.1.2.tar.gz (16.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page