diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 2e82b03..345d223 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,4 +1,4 @@ -name: Generate Python Documentation +name: Documentation on: [pull_request] diff --git a/README.md b/README.md index 90d3756..fc2852d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,12 @@ Template code and examples for python project respecting the [PEP8 coding style](https://peps.python.org/pep-0008/). -[![Licence](https://img.shields.io/badge/licence-Apache%202.0-blue)](LICENSE) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) ![linter](https://github.com/pollen-robotics/python-template/actions/workflows/lint.yml/badge.svg) ![pytest](https://github.com/pollen-robotics/python-template/actions/workflows/pytest.yml/badge.svg) ![coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/FabienDanieau/58642e8fe4589e710e26627e39ff92d7/raw/covbadge.json) - +[![Licence](https://img.shields.io/badge/licence-Apache%202.0-blue)](LICENSE) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) +![linter](https://github.com/pollen-robotics/python-template/actions/workflows/lint.yml/badge.svg) +![pytest](https://github.com/pollen-robotics/python-template/actions/workflows/pytest.yml/badge.svg) +![coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/FabienDanieau/58642e8fe4589e710e26627e39ff92d7/raw/covbadge.json) +![Docs](https://github.com/pollen-robotics/python-template/actions/workflows/docs.yml/badge.svg) ## Quick start