Skip to content

Documentation for the iRobot® Create®3 Educational Robot

License

Notifications You must be signed in to change notification settings

rudislabs/create3_docs

This branch is up to date with iRobotEducation/create3_docs:main.

Folders and files

NameName
Last commit message
Last commit date
Apr 16, 2024
Aug 25, 2024
Oct 14, 2021
Dec 9, 2021
Oct 19, 2021
Mar 7, 2023
Sep 10, 2022
Aug 25, 2024
Sep 10, 2022
May 7, 2024

Repository files navigation

create3_docs

This repository contains the source code for the iRobot® Create® 3 Educational Robot documentation. The automatically generated website can be viewed at https://iroboteducation.github.io/create3_docs/

Build the docs locally

Install required dependencies:

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

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

pip3 install -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.

About

Documentation for the iRobot® Create®3 Educational Robot

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 92.6%
  • HTML 7.4%