@@ -2,6 +2,15 @@
 python-dev-tips, `Slides <https://docs.google.com/presentation/d/1BnezhwUy22DiF72wss8GU_YIMfhjortz-uILdIFGuoM/edit?usp=sharing>`__
 ******************************************************************************************************************************************
 
+.. image:: https://readthedocs.org/projects/python-dev-tips/badge/?version=latest
+    :target: http://python-dev-tips.readthedocs.io/en/latest/
+    :alt: Documentation Status
+
+
+.. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/python.yml/badge.svg
+    :target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/python.yml
+    :alt: Unit tests and formatting
+
 Tutorial first given at ENS Ulm (January 2023) on how to develop a Python package. There is a slight focus on scientific computing, but the general principles apply to any Python project.
 
 .. contents:: **Table of Contents**
@@ -129,6 +138,7 @@ On `GitHub <https://github.com/ebezzam/python-dev-tips/tags>`__ create a new rel
 TODO
 ====
 
+- change documentation links to main branch
 - joblib example in profile
 - github page
 - point out features in scripts: object-oriented, asserts, tqdm, type hints
 
@@ -0,0 +1,33 @@
+Badges
+======
+
+Adding badges to your GitHub repository and documentation amounts to simply adding an image.
+
+For example, in a `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`__ file:
+
+.. code:: rst
+
+    .. image:: https://readthedocs.org/projects/python-dev-tips/badge/?version=latest
+        :target: http://python-dev-tips.readthedocs.io/en/latest/
+        :alt: Documentation Status
+
+which when rendered will make the following badge:
+
+.. image:: https://readthedocs.org/projects/python-dev-tips/badge/?version=latest
+    :target: http://python-dev-tips.readthedocs.io/en/latest/
+    :alt: Documentation Status
+
+You can also create `badges from GitHub Actions <https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge>`__.
+
+.. code:: rst
+
+    .. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/python.yml/badge.svg
+        :target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/python.yml
+        :alt: Unit tests and formatting
+
+.. image:: https://github.com/ebezzam/python-dev-tips/actions/workflows/python.yml/badge.svg
+    :target: https://github.com/ebezzam/python-dev-tips/blob/main/.github/workflows/python.yml
+    :alt: Unit tests and formatting
+
+Finally, you can use `Badgen <https://badgen.net/>`__ to create custom badges.
+
@@ -1,7 +1,7 @@
 Documentation
 =============
 
-We will be using a `Sphinx <https://www.sphinx-doc.org/en/master/>`__ to generate documentation from 
+We will be using `Sphinx <https://www.sphinx-doc.org/en/master/>`__ to generate documentation from 
 docstrings that are written within code. Docstrings are long-form
 comments beneath class and functions declaration that typically describe:
 
@@ -148,6 +148,7 @@ To publish on RTD:
 
 #. Make an account: https://readthedocs.org/accounts/signup/
 #. Import a project from the `dashboard <https://readthedocs.org/dashboard/>`__. There are two ways to do this: (1) linking your GitHub account and selecting one of your **public** repositories, or (2) importing the project manually. When linking to GitHub, the documentation is re-built whenever there are changes to the selected branch.
+#. Check your project page for the build status.
 
-You can (optionally) define a `.readthedocs.yaml <>`__ 
+You can (optionally) define a `.readthedocs.yaml <https://github.com/ebezzam/python-dev-tips/blob/feat/docs/.readthedocs.yaml>`__ 
 file to ensure a build environment as close as possible to your local machine.
@@ -16,6 +16,7 @@ Contents
 .. toctree::
 
    documentation
+   badges
 
 .. toctree::
    :caption: Code