PythonRobotics

mirror of https://github.com/AtsushiSakai/PythonRobotics.git synced 2026-01-13 16:47:55 -05:00

Files

dependabot[bot] d08a044f75 Update sphinx requirement from <4.0 to <5.0 (#612 )

Updates the requirements on [sphinx](https://github.com/sphinx-doc/sphinx) to permit the latest version.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/4.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v0.1.61611...v4.3.2)

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

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

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

2021-12-28 08:00:15 +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

getting_started_main.rst

Add how to contribute docs (#573 )

2021-11-25 23:05:25 +09:00

how_to_contribute_main.rst

add doc policy (#609 )

2021-12-26 10:55:21 +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

requirements.txt

Update sphinx requirement from <4.0 to <5.0 (#612 )

2021-12-28 08:00:15 +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/