Skip to content

Latest commit

 

History

History
 
 

README.md

XLeRobot Documentation

Install Sphinx and Theme

# In the project root pip install -e .[docs]

Build the documentation

# In docs/ make html

Start a server to watch changes

# In docs/ sphinx-autobuild ./source ./build/html

For github links for the time being must double check they link the right branch/commit

Auto Generate Task Docs

# In docs/ python generate_task_docs.py

Auto Generate Robot Docs

# In docs/ # generate all robot docs python generate_robot_docs.py # update just one robot's documentation python generate_robot_docs.py robot_uid