mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-01-14 22:57:55 -05:00
1656cab0d2
* Update Linux_CI.yml * Update MacOS_CI.yml * Update Windows_CI.yml * Delete .lgtm.yml * Update lqr_planner.py * Update lqr_planner.py * Update config.yml * Update environment.yml * Update ruff.toml * Update README.md * Update getting_started_main.rst * Update doc_requirements.txt
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
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/