NXP® Development Guides

This repository contains the source code for NXP® Mobile Robotics Dev Guide site. The automatically generated website can be viewed at https://nxp.guide/

Build the docs locally

Install required dependencies:

pip3 install mkdocs
pip3 install mkdocs-material
pip3 -r requirements.txt

Optionally, if you desire to generate images of STL models dynamically install:

pip3 -r model_image_generation.txt

Build the documentation locally:

mkdocs serve

Open http://127.0.0.1:8000/ in a browser to visualize the docs.

Updating the docs

After commits are pushed to the main branch a new build of the website will automatically start.