mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-04-22 03:00:22 -04:00
64779298ff
* refactor: rename files and update references for inverted pendulum and path tracking modules * refactor: rename inverted pendulum control files and update type check references * refactor: update import statements to use consistent casing for InvertedPendulum module
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/