mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-01-13 14:48:02 -05:00
67a3ca7138
* add state machine state_machine test state_machine_update * add state machine test/doc * state machine update * state machine generate_plantuml() can show diagram by using https://www.plantuml.com/plantuml/
Python Robotics Documentation
This folder contains documentation for the Python Robotics project.
Build the Documentation
Install Sphinx and Theme
pip install sphinx sphinx-autobuild sphinx-rtd-theme sphinx_rtd_dark_mode sphinx_copybutton sphinx_rtd_dark_mode
Building the Docs
In the docs/ folder:
make html
if you want to building each time a file is changed:
sphinx-autobuild . _build/html
Check the generated doc
Open the index.html file under docs/_build/