PythonRobotics

mirror of https://github.com/AtsushiSakai/PythonRobotics.git synced 2026-01-14 16:08:05 -05:00

Files

dependabot[bot] 3c1162561a Bump ipython from 7.31.1 to 8.10.0 in /docs (#791 )

Bumps [ipython](https://github.com/ipython/ipython) from 7.31.1 to 8.10.0.
- [Release notes](https://github.com/ipython/ipython/releases)
- [Commits](https://github.com/ipython/ipython/compare/7.31.1...8.10.0)

---
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>

2023-02-11 10:48:51 +09:00

_static

Add how to contribute docs (#573 )

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

_templates

enhance_github pages doc (#676 )

2022-05-08 14:49:20 +09:00

modules

Adding point cloud sampling examples (#770 )

2023-01-03 22:27:55 +09:00

conf.py

using ruff instead of flake8 (#787 )

2023-01-30 21:33:49 +09:00

doc_requirements.txt

Bump ipython from 7.31.1 to 8.10.0 in /docs (#791 )

2023-02-11 10:48:51 +09:00

getting_started_main.rst

using ruff instead of flake8 (#787 )

2023-01-30 21:33:49 +09:00

how_to_contribute_main.rst

remove old doc links (#677 )

2022-05-08 15:56:51 +09:00

index_main.rst

Enhance bspline code and doc clean up (#720 )

2022-09-27 21:49:53 +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/