Skip to content

Robpol86/sphinx-imgur

Repository files navigation

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