BadgesΒΆ

Adding badges to your GitHub repository and documentation amounts to simply adding an image.

For example, in a reStructuredText file:

.. image:: https://readthedocs.org/projects/pydevtips/badge/?version=latest
    :target: http://pydevtips.readthedocs.io/en/latest/
    :alt: Documentation Status

which when rendered will make the following badge:

Documentation Status

You can also create badges from GitHub Actions.

.. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/poetry.yml/badge.svg
    :target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/poetry.yml
    :alt: Unit tests and formatting
Unit tests and formatting

Finally, you can use Badgen or Shields.io to create custom badges.