To build the pdf and html of the tools:

1) Clone the Docs_Tools repo (form intenral github) - recursively to pull in submodules

https://github0.xmos.com/xmos-int/docs_tools


2) I have my local doc_builder, which has:
(a) a modified conf.py which lists the pdf latex_documnets explicitily.  This was really for me to find broken docs one at a time, but haven't reverted to the original code that finds all the docs  as 
this relies on the folder structure I think!
(b) Copy in the 2 directives form the conf.py in the docs_tools repo - see the last few lines
(c) Added the breath files - this is a bodge as the stock builder builds all the doxygen at once, but it seems the ttols team do it per sub-directory of source files, so my version all points to one place, and hopse that the function names are unique!
(d) and also copies in some directives and breath config from the docs_tools repo conf.py

3) Created a settings.json in the docs_tools repo.

Build the doc byilder (in WSL2) with:

docker build -t doc_builder_local doc_builder/


Run the doc builder from the docs_tools folder with:

docker run --rm -it -u "$(id -u):$(id -g)" -v $(pwd):/build -e DOC_DIR=. -e REPO:/build -e DOXYGEN_INCLUDE=/build/Doxyfile.inc -e DEV=1  -e SKIP_LINK=1 -e PDF=1 doc_builder_local


Note - I fixed on table, line 409 in flash.rst to replace a table row seperator form "=" to "-" characters. Never found a reason why this breaks the pdf.


-----------------------------------
HOW TO BUILD THE SLN_VOICE DOCS:

docker run --rm -t -u "$(id -u):$(id -g)" -v $(pwd):/build -e PDF=1 -e SKIP_LINK=1 -e REPO:/build -e EXCLUDE_PATTERNS=/build/doc/exclude_patterns.inc -e DOXYGEN_INCLUDE=/build/doc/Doxyfile.inc -e DOXYGEN_INPUT=ignore doc_builder_local


docker run --rm -t -u "$(id -u):$(id -g)" -v $(pwd):/build -e PDF=1 -e SKIP_LINK=1 -e REPO:/build  -e DOXYGEN_INCLUDE=/build/doc/Doxyfile.inc -e DOXYGEN_INPUT=ignore doc_builder_local


-----------------------------------
HOW TO BUILD SW_USB_AUDIO

docker run --rm -it -u "$(id -u):$(id -g)" -v $(pwd):/build -e DOC_DIR=. -e REPO:/build -e DOXYGEN_INCLUDE=/build/Doxyfile.inc -e DEV=1  -e SKIP_LINK=1 -e PDF=0 doc_builder_local

------------------------------------
HOW TO BUIILD THE DOCKER

docker build -t doc_builder_local .



-------------------------------------
PUBLICHING DOCKER

(1) login t dockerhub from command line, using this token:

docker login -u andrewxmos
use a token as the password

(2) tag the image

docker tag doc_builder_local andrewxmos/tools_doc_builder

(3) push the image

docker push andrewxmos/tools_doc_builder