Hi,
I've found that in most repos there is a doc folder, which contains a bunch of .rst files. These files seem to be used to build documentation with a hierarchy/table of contents, etc.
For example: https://github.com/xmos/sw_usb_audio/tr ... op/doc/rst
What is the recommended way of reading these docs? Are they hosted somewhere?
How to read documentation? Topic is solved
-
- Member++
- Posts: 26
- Joined: Thu Jun 27, 2024 3:38 pm
-
Verified
- XCore Legend
- Posts: 1049
- Joined: Thu Dec 10, 2009 9:20 pm
- Location: Bristol, UK
Easiest way from GitHub is, click on release, then go down to assets, you'll see sw_usb_audio.pdf.
That document is also published on xmos.com on this page: https://www.xmos.com/develop/usb-multichannel-audio/
That document is also published on xmos.com on this page: https://www.xmos.com/develop/usb-multichannel-audio/
Technical Director @ XMOS. Opinions expressed are my own
-
- Member++
- Posts: 26
- Joined: Thu Jun 27, 2024 3:38 pm
I see, thank you!