fixes for xmosdoc v4

also will need update to mic_array
xmos · Sep 22, 2023 · a14bfbd · a14bfbd
1 parent aafc47c
commit a14bfbd
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 12 deletions.
diff --git a/doc/exclude_patterns.inc b/doc/exclude_patterns.inc
@@ -1,5 +1,7 @@
 # The following patterns are to be excluded from the documentation build
-doc/README.rst
+CHANGELOG.rst
+LICENSE.rst
+**README*
 examples
 test
 tools

diff --git a/doc/shared/legal.rst b/doc/shared/legal.rst
@@ -1,8 +1,6 @@
 .. _sln_voice_copyright:
 
 
-.. include:: ../_templates/disclaimer.rst
-
 Licenses
 ========
 

diff --git a/doc/src_html/.gitkeep b/doc/src_html/.gitkeep
diff --git a/doc/substitutions.rst b/doc/substitutions.rst
diff --git a/modules/uart/api/uart.h b/modules/uart/api/uart.h
@@ -26,7 +26,7 @@
  * Enum type representing the different options
  * parity types.
  */
-typedef enum uart_parity_t {
+typedef enum {
  UART_PARITY_NONE = 0,
  UART_PARITY_EVEN,
  UART_PARITY_ODD

diff --git a/settings.json b/settings.json
diff --git a/settings.yml b/settings.yml
@@ -0,0 +1,14 @@
+---
+project: fwk_io
+title: XCORE Peripheral IO Framework
+version: 3.1.0
+
+documentation:
+ exclude_patterns_path: doc/exclude_patterns.inc
+ doxygen_projects:
+ fwk_io:
+ doxyfile_path: doc/Doxyfile.inc
+ pdfs:
+ doc/programming_guide/index:
+ pdf_title: "{{title}} - Programming Guide"
+ pdf_filename: "{{project}}_programming_guide_v{{version}}"