github/PythonRobotics
1
1
Fork 0
mirror of https://github.com/AtsushiSakai/PythonRobotics.git synced 2026-01-14 12:07:56 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
7c3dbb01e0d1fd64f6eb9c37799161930b9d664d
PythonRobotics/docs
History
dependabot[bot] 7c3dbb01e0 Bump ipython from 7.30.1 to 7.31.1 in /docs (#628) 
Bumps [ipython](https://github.com/ipython/ipython) from 7.30.1 to 7.31.1.
- [Release notes](https://github.com/ipython/ipython/releases)
- [Commits](https://github.com/ipython/ipython/compare/7.30.1...7.31.1)

---
updated-dependencies:
- dependency-name: ipython
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-01-22 07:36:51 +09:00
..
_static
Add how to contribute docs (#573)
2021-11-25 23:05:25 +09:00
modules
Add a Robot class for Move to Pose Algorithm (#596)
2021-12-25 21:42:32 +09:00
conf.py
clean up SLAM docs (#572)
2021-11-21 22:39:18 +09:00
doc_requirements.txt
Bump ipython from 7.30.1 to 7.31.1 in /docs (#628)
2022-01-22 07:36:51 +09:00
getting_started_main.rst
Add how to contribute docs (#573)
2021-11-25 23:05:25 +09:00
how_to_contribute_main.rst
add diff style check test (#617)
2022-01-06 20:26:24 +09:00
index_main.rst
Adding all gifs to the doc 2 (#585)
2021-11-28 16:00:02 +09:00
make.bat
Add base doc files
2018-09-15 15:04:02 +02:00
Makefile
Add base doc files
2018-09-15 15:04:02 +02:00
README.md
Add how to contribute docs (#573)
2021-11-25 23:05:25 +09:00

README.md

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/

Reference in New Issue View Git Blame Copy Permalink