Luxonis DepthAI Docs Website

How to contribute

The DepthAI docs are designed to be easily updated. See an issue? Follow these steps:

While on a https://docs.luxonis.com page with an issue, scroll down to the footer.
Click the "Edit on GitHub" link. This takes you to the page source.
For simple changes (like a typo), anyone can edit the page directly on GitHub and submit a PR. Repository contributors with write access can also commit changes directly to master. However, use caution: master is auto-deployed on changes so limit direct commits to minor changes and use PRs for more significant updates.
For complex changes (like adding a new page to the site), follow the "Local Development" steps below.

The site is powered by Sphinx.

./install_dependencies.sh

make html
cd build/html
python3 -m http.server

git push the master branch to deploy via ReadTheDocs.

To update redirects on the page, see source/redirects.yml.

Then, when everything is updated, please use

rtd-redirects luxonis-docs-website ./source/redirects.yml --pro --username <username> --password <pass>

Username and password are the credentials you use to access the RTD website

You need to have sufficient privileges on the RTD to change the redirects