Skip to content

Commit 486a6f0

Browse files
authored
Add documentation badge to README
Added documentation badge links for project documentation.
1 parent 52fae47 commit 486a6f0

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Drone controllers @ LSY. Contains arrayAPI (i.e., NumPy, JAX, Torch...) implementations for various onboard drone controllers.
88

9-
[![Python Version]][Python Version URL] [![Ruff Check]][Ruff Check URL] [![Tests]][Tests URL]
9+
[![Python Version]][Python Version URL] [![Ruff Check]][Ruff Check URL] [![Tests]][Tests URL] [![Docs]][Docs URL]
1010

1111
[Python Version]: https://img.shields.io/badge/python-3.10+-blue.svg
1212
[Python Version URL]: https://www.python.org
@@ -17,6 +17,9 @@ Drone controllers @ LSY. Contains arrayAPI (i.e., NumPy, JAX, Torch...) implemen
1717
[Tests]: https://github.com/utiasDSL/drone-controllers/actions/workflows/testing.yml/badge.svg
1818
[Tests URL]: https://github.com/utiasDSL/drone-controllers/actions/workflows/testing.yml
1919

20+
[Docs]: https://github.com/utiasDSL/drone-controllers/actions/workflows/docs.yml/badge.svg
21+
[Docs URL]: https://utiasdsl.github.io/drone-controllers/
22+
2023
## Installation
2124

2225
1. Clone repository `git clone git@github.com:utiasDSL/drone-controllers.git`
@@ -30,4 +33,4 @@ TODO
3033

3134
## Testing
3235
1. Install testing environment with `pixi install -e test`
33-
1. Run tests with `pixi run -e test pytest`
36+
1. Run tests with `pixi run -e test pytest`

0 commit comments

Comments
 (0)