Go to https://jomjol.github.io/AI-on-the-edge-device-docs to use it.
This repo contains the documentation for the AI-on-the-Edge-Device Project.
*.md
document in the docs folder.main
branch (or edit it directly in the main
branch if you have the required rights).gh-pages
branch. This branch automatically gets populated to the public Documentation SiteEach page has a link on its top-right corner Edit on GitHub
which brings you directly to the Github editor.
*.md
document in the docs folder.Each parameter in the main project repo is documented in a separate file, see https://github.com/jomjol/AI-on-the-edge-device/tree/rolling/param-docs. The script in param-docs/concat-parameter-pages.py
collects them and compiles it into the documentation as provided in https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters.
The script should be run whenever one of the pages changed.
This happens automatically daily in the Github action.
if you run it manually, make sure to clone the main repo first, eg. using:
cd param-docs
git clone https://github.com/jomjol/AI-on-the-edge-device.git
python concat-parameter-pages.py
The script generate-template-param-doc-pages.py
should be run whenever a new parameter gets added to the config file.
It then checks if there is already page for each of the parameters.
If the parameter is listed in expert-params.txt
, an Expert warning will be shown.
If the parameter is listed in hidden-in-ui.txt
, a Note will be shown.
Boxes can be shown using the admonition extension.
!!! Note
I am a note
Make sure to have 4-whitespace Intents!
Possible types: attention, caution, danger, error, hint, important, note, tip, and warning
See https://python-markdown.github.io/extensions/admonition/
To test it locally:
pip install --upgrade pip
pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin mkdocs-material pymdown-extensions mkdocs-enumerate-headings-plugin
In the main folder of the repo, call mkdocs serve
(and keep it running).
This will locally generate the documentation.
You can access it under http://127.0.0.1:8000/AI-on-the-edge-device-docs/
Any change to the files will automatically be applied.