Skip to main content

Embed Imgur images and albums in Sphinx documents/pages.

Project description

sphinx-imgur

Embed Imgur images and albums in Sphinx documents/pages.

  • Python 3.6, 3.7, 3.8, and 3.9 supported on Linux, macOS, and Windows.

📖 Full documentation: https://sphinx-imgur.readthedocs.io

Github-CI Coverage Status Documentation Status Code style: black PyPI PyPI Downloads

Quickstart

To install run the following:

pip install sphinx-imgur

To use in Sphinx simply add to your conf.py:

extensions = ["sphinx_imgur.imgur"]

And in your Sphinx documents:

.. imgur:: 611EovQ

Or to use Imgur's embed feature with an album:

.. imgur-embed:: a/9YZHA

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

sphinx-imgur-3.0.0.tar.gz (6.4 kB view hashes)

Uploaded Source

Built Distribution

sphinx_imgur-3.0.0-py3-none-any.whl (7.4 kB view hashes)

Uploaded 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