mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-01-14 09:08:01 -05:00
* clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * add contribution doc * add contribution doc * add contribution doc * add contribution doc * add contribution doc
30 lines
460 B
Markdown
30 lines
460 B
Markdown
## 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/
|