From 4f0520e12e602cdeb47c7a5690372e529b7a7218 Mon Sep 17 00:00:00 2001 From: xross Date: Fri, 10 Nov 2017 11:18:47 +0000 Subject: [PATCH] Added basic doc files --- lib_xua/doc/rst/index.rst | 17 +++++++++++++++++ lib_xua/doc/rst/xdoc.conf | 2 ++ 2 files changed, 19 insertions(+) create mode 100644 lib_xua/doc/rst/index.rst create mode 100644 lib_xua/doc/rst/xdoc.conf diff --git a/lib_xua/doc/rst/index.rst b/lib_xua/doc/rst/index.rst new file mode 100644 index 00000000..92c1579e --- /dev/null +++ b/lib_xua/doc/rst/index.rst @@ -0,0 +1,17 @@ + +.. include:: ../../../README.rst + + +XMOS USB Audio +============== + +This document details the XMOS USB Audio Library. This library +enables the development of USB Audio devices on the XMOS xCORE architecture. + +This document describes the structure of the library, its basic use +and resources required. + +This document assumes familiarity with the XMOS xCORE architecture, the +Universal Serial Bus 2.0 Specification (and related specifications), +the XMOS tool chain and XC language. + diff --git a/lib_xua/doc/rst/xdoc.conf b/lib_xua/doc/rst/xdoc.conf new file mode 100644 index 00000000..2cef5f56 --- /dev/null +++ b/lib_xua/doc/rst/xdoc.conf @@ -0,0 +1,2 @@ +XMOSNEWSTYLE = 1 +DOXYGEN_DIRS=../../api \ No newline at end of file