Generate api doc (#4)

.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: API documentation generation
+
+on:
+ push:
+ branches:
+ - master
+
+permissions:
+ pages: write
+ id-token: write
+
+jobs:
+ doc:
+ runs-on: ubuntu-latest
+ container: hrektts/doxygen
+ steps:
+ - uses: actions/checkout@v3
+ - run: |
+ doxygen doc/doxygen.cfg
+ mv html _site
+ mv _site/group__uprofile.html _site/index.html
+ name: Generate doc
+ - name: Upload Pages artifact
+ uses: actions/upload-pages-artifact@v2
+ - name: Deploy to GitHub Pages
+ uses: actions/deploy-pages@v2

README.md

@@ -2,6 +2,7 @@
 
 ![GitHub tag](https://img.shields.io/github/tag/Orange-OpenSource/cppuprofile)
 ![Licensing](https://img.shields.io/github/license/Orange-OpenSource/cppuprofile)
+[![Documentation](https://img.shields.io/badge/documentation-ok-green)](https://orange-opensource.github.io/cppuprofile/)
 
 ![Linux](https://img.shields.io/badge/Linux-full_support-green?logo=linux&logoColor=white)
 ![Windows](https://img.shields.io/badge/Windows-partial_support-orange?&logo=windows&logoColor=white)
@@ -25,10 +26,11 @@ Metrics are stored in a CSV file (the path is configurable).
 
 ## Usage
 
-The library is lightweight, simple and easy to use. It can be easily used from an existing
-application or integrated in a dedicated monitoring application.
+The library is lightweight, simple and easy to use. It can be easily used from an existing application or integrated in a dedicated monitoring application.
 
-### System memory and CPU usage onitoring
+Full API documentation is available [here](https://orange-opensource.github.io/cppuprofile/).
+
+### System memory and CPU usage monitoring
 
 ```cpp
 #include <uprofile/uprofile.h>