Documentation updates (including fix incorrect version)

xmos · Oct 17, 2024 · 24b08fa · 24b08fa
1 parent e044f56
commit 24b08fa
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/doc/Doxyfile.inc b/doc/Doxyfile.inc
@@ -1,7 +1,7 @@
 # This file provides overrides to the Doxyfile configuration
 
 PROJECT_NAME           = lib_random
-PROJECT_BRIEF          = "Random Number Generation"
+PROJECT_BRIEF          = "Random number generation"
 
 INPUT                  = ../lib_random/api
 

diff --git a/doc/rst/lib_random.rst b/doc/rst/lib_random.rst
@@ -1,6 +1,6 @@
 
 ####################################
-lib_random: Random Number Generation
+lib_random: Random number generation
 ####################################
 
 ************
@@ -27,7 +27,7 @@ An application should then the ``random.h`` header file::
 Example
 *******
 
-An example demonstrating how to generate random values using the ``lib_random`` library is provide
+An example demonstrating how to generate random values using the ``lib_random`` library is provided
 in `examples/app_random`
 
 It shows the two different methods for initialising a random number generator (software or hardware

diff --git a/settings.yml b/settings.yml
@@ -1,17 +1,17 @@
 # This file relates to internal XMOS infrastructure and should be ignored by external users
-
+---
 lib_name: lib_random
 project: '{{lib_name}}'
-title: '{{lib_name}}: Random Number Generation'
-version: 2.3.2
+title: '{{lib_name}}: Random number generation'
+version: 1.2.0
 
 documentation:
   exclude_patterns_path: doc/exclude_patterns.inc
   root_doc: doc/rst/lib_random.rst
   linkcheck_ignore_regex: ['']
   cognidox_part_number: XM-011312-UG
   doxygen_projects:
-    lib_xud:
+    lib_random:
       doxyfile_path: doc/Doxyfile.inc
   pdfs:
     doc/rst/lib_random.rst: