mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-01-09 04:18:04 -05:00
db3b1ab873
* Initial plan * Fix typos in comments and documentation Co-authored-by: AtsushiSakai <3813847+AtsushiSakai@users.noreply.github.com> * Revert filename change in users_comments.md as requested Co-authored-by: AtsushiSakai <3813847+AtsushiSakai@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: AtsushiSakai <3813847+AtsushiSakai@users.noreply.github.com>
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/