About these docs¶

The manual is built with Sphinx from Markdown (MyST).

Build¶

$ python3 -m venv .venv && .venv/bin/pip install -r requirements.txt
$ make html            # → build/html/index.html

Links that will change¶

The source repositories and their releases are public under NexusNoki on GitHub. Every GitHub link in this manual is built from variables in source/conf.py, so a move to another organisation or host needs no page edits:

Variable	Current value	Override at build time
`github_owner`	`NexusNoki`	`NN_DOCS_GITHUB_OWNER`
`github_host`	`https://github.com`	`NN_DOCS_GITHUB_HOST`
`repo_hub`	`nn-hub`	`NN_DOCS_REPO_HUB`
`repo_modules`	`nn-modules`	`NN_DOCS_REPO_MODULES`
`repo_camera_byai`	`nn-app-camera-beagleyai-imx708`	`NN_DOCS_REPO_CAMERA_BYAI`
`rel_sensor`	`nn-app-mdns-ot-esp32c6`	`NN_DOCS_REL_SENSOR`
`rel_ncp`	`nn-app-ncp-esp32c6`	`NN_DOCS_REL_NCP`
`rel_cam_p4_wifi6`	`nn-app-camera-esp32p4-wifi6-sdio-ov5647`	`NN_DOCS_REL_CAM_P4_WIFI6`
`rel_cam_p4_module`	`nn-app-camera-esp32p4module-sdio-ov5647`	`NN_DOCS_REL_CAM_P4_MODULE`
`rel_byai_sdcard`	`nn-app-camera-beagleyai-imx708`	`NN_DOCS_REL_BYAI_SDCARD`
`hub_ip`	`192.168.1.50`	`NN_DOCS_HUB_IP`
`media_ip`	`192.168.1.51`	`NN_DOCS_MEDIA_IP`
`repos_public`	`yes`	`NN_DOCS_REPOS_PUBLIC` (`yes` shows the source link in the page header)

Each repo_* and rel_* variable also gives <name>_url (the repository page), and each rel_* gives <name>_releases (its releases page).

$ NN_DOCS_GITHUB_OWNER=<new-org> NN_DOCS_REPOS_PUBLIC=yes make html

In a page, write @@name@@ for any variable — it is replaced everywhere, code blocks included, and an unknown name fails the build.