Skip to content

Commit f1b171d

Browse files
authored
Update head doc (#1127)
* update head doc * update head doc
1 parent bf8f177 commit f1b171d

File tree

3 files changed

+34
-19
lines changed

3 files changed

+34
-19
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 - 2022 Atsushi Sakai and other contributors:
3+
Copyright (c) 2016 - now Atsushi Sakai and other contributors:
44
https://github.com/AtsushiSakai/PythonRobotics/contributors
55

66
Permission is hereby granted, free of charge, to any person obtaining a copy

docs/getting_started_main.rst

+17-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@
33
Getting Started
44
===============
55

6-
What is this?
7-
-------------
6+
.. _`What is PythonRobotics?`:
7+
8+
What is PythonRobotics?
9+
------------------------
810

911
This is an Open Source Software (OSS) project: PythonRobotics, which is a Python code collection of robotics algorithms.
1012

13+
This is developped under `MIT license`_ and on `GitHub`_.
14+
1115
The focus of the project is on autonomous navigation, and the goal is for beginners in robotics to understand the basic ideas behind each algorithm.
1216

1317
In this project, the algorithms which are practical and widely used in both academia and industry are selected.
@@ -16,6 +20,17 @@ Each sample code is written in Python3 and only depends on some standard modules
1620

1721
It includes intuitive animations to understand the behavior of the simulation.
1822

23+
.. _GitHub: https://github.com/AtsushiSakai/PythonRobotics
24+
.. _`MIT license`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/LICENSE
25+
26+
Features:
27+
28+
1. Easy to read for understanding each algorithm's basic idea.
29+
30+
2. Widely used and practical algorithms are selected.
31+
32+
3. Minimum dependency.
33+
1934

2035
See this paper for more details:
2136

docs/index_main.rst

+16-16
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,32 @@
66
Welcome to PythonRobotics's documentation!
77
==========================================
88

9-
Python codes for robotics algorithm. The project is on `GitHub`_.
9+
"PythonRobotics" is a Python code collections and html based text book
10+
(This document) for robotics algorithm, which is developed on `GitHub`_.
1011

11-
This is a Python code collection of robotics algorithms.
12+
See this section (:ref:`What is PythonRobotics?`) for more details of this project.
1213

13-
Features:
14+
This project is `the one of the most popular open-source software (OSS) in
15+
the field of robotics on GitHub`_.
16+
This is `user comments about this project`_, and
17+
this graph shows GitHub star history of this project:
1418

15-
1. Easy to read for understanding each algorithm's basic idea.
19+
.. image:: https://api.star-history.com/svg?repos=AtsushiSakai/PythonRobotics&type=Date
20+
:alt: Star History
21+
:width: 80%
22+
:align: center
1623

17-
2. Widely used and practical algorithms are selected.
1824

19-
3. Minimum dependency.
20-
21-
See this paper for more details:
22-
23-
- `[1808.10703] PythonRobotics: a Python code collection of robotics
24-
algorithms`_ (`BibTeX`_)
25-
26-
27-
.. _`[1808.10703] PythonRobotics: a Python code collection of robotics algorithms`: https://arxiv.org/abs/1808.10703
28-
.. _BibTeX: https://github.com/AtsushiSakai/PythonRoboticsPaper/blob/master/python_robotics.bib
2925
.. _GitHub: https://github.com/AtsushiSakai/PythonRobotics
26+
.. _`user comments about this project`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/users_comments.md
27+
.. _`MIT license`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/LICENSE
28+
.. _`the one of the most popular open-source software (OSS) in the field of robotics on GitHub`: https://github.com/topics/robotics
3029

30+
----------------------------------
3131

3232
.. toctree::
3333
:maxdepth: 2
34-
:caption: Contents
34+
:caption: Table of Contents
3535

3636
getting_started
3737
modules/1_introduction/introduction

0 commit comments

Comments
 (0)