Merge pull request #711 from LedgerHQ/improve-sdk-documentation

Improve sdk documentation

.github/workflows/documentation.yml

@@ -0,0 +1,46 @@
+name: Documentation generation & update
+
+on:
+ push:
+ tags:
+ - '*'
+ branches:
+ - master
+ pull_request:
+ branches:
+ - master
+
+jobs:
+ generate:
+ name: Generate the documentation
+ runs-on: ubuntu-latest
+ steps:
+ - name: Clone
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ - name: Install APT dependencies
+ run: |
+ sudo apt-get update
+ sudo apt-get install graphviz doxygen
+ - name: Generate the documentation
+ run: make doc
+ - name: Upload documentation bundle
+ uses: actions/upload-artifact@v4
+ with:
+ name: documentation
+ path: build/doc/html/
+
+ deploy:
+ name: Deploy the documentation on Github pages
+ runs-on: ubuntu-latest
+ needs: generate
+ if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/'))
+ steps:
+ - name: Download documentation bundle
+ uses: actions/download-artifact@v4
+ - name: Deploy documentation on pages
+ uses: peaceiris/actions-gh-pages@v4
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: documentation/

doc/mainpage.dox

@@ -47,9 +47,9 @@ The @subpage u2f_mainpage page contains all information necessary to use the U2F
 The @subpage ux_mainpage page contains all information necessary to user the User eXperience (and partially Graphical Library) for
 \b Nanos applications development (using \b BAGL).
 
-@subsection ux_stax_presentation User eXperience on Applications using \b NBGL
+@subsection ux_nbgl_presentation User eXperience on Applications using \b NBGL
 
-The @subpage ux_stax_mainpage page contains all information necessary to user the User eXperience for
+The @subpage ux_nbgl_mainpage page contains all information necessary to user the User eXperience for
 \b Stax, \b NanoX and \b NanoS+ applications development using \b NBGL (most recent ones).
 
 

lib_blewbxx_impl/doc/mainpage.dox

@@ -1,6 +1,6 @@
 /** @page ble_mainpage BlueTooth Low-Energy Stack
 
-@section mainpage_intro Introduction
+@section ble_mainpage_intro Introduction
 
 This page describes the API of BLE (BlueTooth Low-Energy) Stack provided in \b NanoX and \b Stax products.
 

lib_cxng/doc/mainpage.dox

@@ -1,6 +1,6 @@
 /** @page cxng_mainpage Cryptographic Library
 
-@section mainpage_intro Introduction
+@section cxng_mainpage_intro Introduction
 
 This documentation describes the different interfaces of Bolos Cryptographic Library.
 

lib_nbgl/doc/mainpage.dox

@@ -1,7 +1,7 @@
 #ifdef HAVE_SE_TOUCH
 /** @page nbgl_mainpage New BOLOS Graphic API for Stax
 
-@section mainpage_intro Introduction
+@section nbgl_mainpage_intro Introduction
 
 This documentation describes the different interfaces of <b>NBGL</b>, the library that
 is targeted to be integrated in Stax product.