Adding workflow to create Cordio platform docs. #403
Conversation
Adding Doxyfile for Cordio documentation workflow support
There was a problem hiding this comment.
I think we can make this platform agnostic. This documentation will apply to all platforms, not just the MAX32655.
We should remove the interfaces that we don't really implement. It looks like we've already excluded most of the un-used interfaces, but we can also remove the audio and codec interfaces.
|
Can we give some names to the anonymous entries? |
| @@ -0,0 +1,67 @@ | |||
| from pathlib import Path | |||
| from os import listdir | |||
|
|
|||
There was a problem hiding this comment.
So this looks for markdown files and PDFs and adds links to USERGUIDE.md?
Maybe we should move this to the workflows folder?
There was a problem hiding this comment.
moved, but we will have to do a test to double check the new pathing from that file
Documentation/USERGUIDE.md
Outdated
| @@ -1584,6 +1584,12 @@ The Cordio Bluetooth Low Energy (BLE) library provides a full BLE stack for micr | |||
| - MAX32680 | |||
| - MAX32690 | |||
|
|
|||
| #### Cordio Documentation | |||
|
|
|||
| - [Architecture](ARCHITECTURE.md) | |||
There was a problem hiding this comment.
I think we'll have to add a path for these links to work.
There was a problem hiding this comment.
tested it a couple different times on my machine, since the workflow copies those files in the same directory as the userguide.md file , pathing like this works fine
There was a problem hiding this comment.
If we look at this file in the main branch then the path will be wrong. I don't think we should permanently copy the markdown files into this directory.
| sudo make -C Libraries/Cordio/docs/latex | ||
|
|
||
| echo "Copying PDF to Cordio/platform/Documentation" | ||
| sudo mv Libraries/Cordio/docs/latex/refman.pdf Libraries/Cordio/docs/latex/Cordio-Platform-Documentation.pdf |
There was a problem hiding this comment.
This filename looks okay, we just need to update what's currently in the PR.
| ## BLE_hci | ||
| Host Controller Interface for controlling Bluetooth Controller devices. Uses a serial port and the HCI interface to send commands and receive events. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Can we double check this is the current help text?
There was a problem hiding this comment.
"HCI Tool used to control a Bluetooth Controller through a serial port." is the current help text in the main branch python file, but no README is present there
There was a problem hiding this comment.
If you run with the -h parameter and send the help command then we get this help text.
python3 BLE_hci.py -h
python3 BLE_hci.py
help
|
Can we close this? |
No description provided.