How to read documentation? Topic is solved

New to XMOS and XCore? Get started here.
andy-aic
Member++
Posts: 26
Joined: Thu Jun 27, 2024 3:38 pm

How to read documentation?

Post by andy-aic »

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?
View Solution
User avatar
Ross
Verified
XCore Legend
Posts: 1052
Joined: Thu Dec 10, 2009 9:20 pm
Location: Bristol, UK

Post by Ross »

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/
Technical Director @ XMOS. Opinions expressed are my own
andy-aic
Member++
Posts: 26
Joined: Thu Jun 27, 2024 3:38 pm

Post by andy-aic »

I see, thank you!