update readme and add test framework readme in the github pages docs

.github/workflows/publish-docs.yml

@@ -24,8 +24,8 @@ jobs:
         wget https://github.com/matusnovak/doxybook2/releases/download/v1.4.0/doxybook2-linux-amd64-v1.4.0.zip
         unzip doxybook2-linux-amd64-v1.4.0.zip; cd ../
         chmod +x doxybook2/bin/doxybook2
-        mkdir docs/docs
-        ./doxybook2/bin/doxybook2 --input docs/xml --output docs/docs --config docs/doxybook2.json
+        mkdir docs/refmanual
+        ./doxybook2/bin/doxybook2 --input docs/xml --output docs/refmanual --config docs/doxybook2.json
         rm -rf doxybook2
     - run: pip install -r docs/requirements.txt
     - run: mkdocs gh-deploy --force

README.md

@@ -24,7 +24,7 @@ This repository contains:
 
 - `test` folder contains the testing setup used during the development of the library. For more details please read the README file in the folder.
 
-- `doc` folder contains the configurations for building documentation for the library.
+- `docs` folder contains the configurations for building documentation for the library.
 
 # Installation and usage
 
@@ -69,13 +69,15 @@ make install-lib
 
 # Documentation
 
-Go to the `doc` folder and do
+The documentation is built from the latest master and hosted at github pages: [https://pulp-platform.github.io/pulp-dsp](https://pulp-platform.github.io/pulp-dsp), using [MkDocs-Material](https://squidfunk.github.io/mkdocs-material/) and [Doxybook2](https://github.com/matusnovak/doxybook2).
+
+You can also generate the reference manual by yourself by going to the `docs` folder and doing
 
 ~~~~~shell
-doxygen doc_config
+doxygen Doxyfile
 ~~~~~
 
-It creates the documentation and you can browse it by opening `html/index.html` using a browser. 
+It creates the reference manual and you can browse it by opening `html/index.html` using a browser. 
 
 To add documentations use @defgroup, @ingroup, @addtogroup, etc. Please refer to plp_math.h and the source codes src/BasicMathFunctions/plp_dot_prod_i32.c and src/BasicMathFunctions/kernels/plp_dot_prod_i32s_rv32im.c as examples.
 

docs/index.md

@@ -0,0 +1 @@
+../README.md

docs/test-framework-index.md

@@ -0,0 +1 @@
+../test/README.md

mkdocs.yml

@@ -10,10 +10,11 @@ repo_name: pulp-platform/pulp-dsp
 
 nav:
 - Home: index.md
-- Docs:
-  - Pages: docs/Pages/index.md
-  - Files: docs/Files/index.md
-  - Classes: docs/Classes/index.md
-  - Examples: docs/Examples/index.md
-  - Modules: docs/Modules/index.md
-  - Namespaces: docs/Namespaces/index.md
+- Test Framework: test-framework-index.md
+- Reference Manual:
+  - Pages: refmanual/Pages/index.md
+  - Files: refmanual/Files/index.md
+  - Classes: refmanual/Classes/index.md
+  - Examples: refmanual/Examples/index.md
+  - Modules: refmanual/Modules/index.md
+  - Namespaces: refmanual/Namespaces/index.md