Files
PythonRobotics/docs/README.md
Atsushi Sakai 094a413dcd Add how to contribute docs (#573)
* 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
2021-11-25 23:05:25 +09:00

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/