Merge pull request #26 from xross/develop

Doc tidies

CHANGELOG.rst

@@ -4,7 +4,7 @@ lib_adat change log
 2.0.1
 -----
 
-  * CHANGED: Run standard library tests as part of Jenkins testing
+  * CHANGED:   Documentation updated
 
 2.0.0
 -----

Jenkinsfile

@@ -23,14 +23,19 @@ pipeline {
       defaultValue: 'v6.1.2',
       description: 'The xmosdoc version'
     )
+    string(
+        name: 'INFR_APPS_VERSION',
+        defaultValue: 'v2.0.1',
+        description: 'The infr_apps version'
+    )
   }
   environment {
     REPO = 'lib_adat'
     PIP_VERSION = "24.0"
     PYTHON_VERSION = "3.12.1"
   }
   stages {
-    stage('Get sandbox') {
+    stage('Checkout') {
       steps {
         println "Stage running on: ${env.NODE_NAME}"
 
@@ -56,18 +61,20 @@ pipeline {
     }  // Build examples
 
     stage('Library checks') {
-      steps {
-        runLibraryChecks("${WORKSPACE}/${REPO}", "v2.0.1")
-      } // steps
-    }  // Library checks
+        steps {
+            runLibraryChecks("${WORKSPACE}/${REPO}", "${params.INFR_APPS_VERSION}")
+        }
+    }
 
     stage('Documentation') {
-      steps {
-        dir("${REPO}") {
-          buildDocs()
-        } // dir("${REPO}")
-      } // steps
-    } // stage('Documentation')
+        steps {
+            dir("${REPO}") {
+                warnError("Docs") {
+                    buildDocs()
+                }
+            }
+        }
+    }
   } // stages
   post {
     cleanup {

README.rst

@@ -1,7 +1,7 @@
 :orphan:
 
 ########################
-lib_adat: ADAT Lightpipe
+lib_adat: ADAT lightpipe
 ########################
 
 :vendor: XMOS
@@ -29,26 +29,32 @@ Features
   * Application for loopback testing on Simulator or hardware
 
 ************
-Known Issues
+Known issues
 ************
 
   * ADAT Rx: Requirement for 100 MHz reference clock (#18)
   * ADAT Tx: No support for 256x master clock (i.e. 48 kHz from 12.288 MHz master clock) (#17)
 
+****************
+Development repo
+****************
+
+  * `lib_adat <https://www.github.com/xmos/lib_adat>`_
+
 **************
-Required Tools
+Required tools
 **************
 
   * XMOS XTC Tools: 15.3.0
 
 *********************************
-Required Libraries (dependencies)
+Required libraries (dependencies)
 *********************************
 
   * None
 
 *************************
-Related Application Notes
+Related application notes
 *************************
 
 The following application notes use this library: