From 9362248787f08fd60b963487427c7a8c165bbb85 Mon Sep 17 00:00:00 2001 From: Atsushi Sakai Date: Sun, 26 Jan 2025 21:46:01 +0900 Subject: [PATCH 1/2] update head doc --- LICENSE | 2 +- docs/getting_started_main.rst | 15 +++++++++++++-- docs/index_main.rst | 28 ++++++++++++---------------- 3 files changed, 26 insertions(+), 19 deletions(-) diff --git a/LICENSE b/LICENSE index c0c52a4321..1c9b928b54 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2016 - 2022 Atsushi Sakai and other contributors: +Copyright (c) 2016 - now Atsushi Sakai and other contributors: https://github.com/AtsushiSakai/PythonRobotics/contributors Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/docs/getting_started_main.rst b/docs/getting_started_main.rst index 256319ab8f..bf9f265c53 100644 --- a/docs/getting_started_main.rst +++ b/docs/getting_started_main.rst @@ -3,8 +3,10 @@ Getting Started =============== -What is this? -------------- +.. _`What is PythonRobotics?`: + +What is PythonRobotics? +------------------------ This is an Open Source Software (OSS) project: PythonRobotics, which is a Python code collection of robotics algorithms. @@ -17,6 +19,15 @@ Each sample code is written in Python3 and only depends on some standard modules It includes intuitive animations to understand the behavior of the simulation. +Features: + +1. Easy to read for understanding each algorithm's basic idea. + +2. Widely used and practical algorithms are selected. + +3. Minimum dependency. + + See this paper for more details: - PythonRobotics: a Python code collection of robotics algorithms: https://arxiv.org/abs/1808.10703 diff --git a/docs/index_main.rst b/docs/index_main.rst index 67bd9889f2..fdfb3cff0d 100644 --- a/docs/index_main.rst +++ b/docs/index_main.rst @@ -6,32 +6,28 @@ Welcome to PythonRobotics's documentation! ========================================== -Python codes for robotics algorithm. The project is on `GitHub`_. +"PythonRobotics" is a Python code collections and html based text book (This document) for robotics algorithm. +This is an open source software under `MIT license`_ and developed on `GitHub`_. -This is a Python code collection of robotics algorithms. +See this section (:ref:`What is PythonRobotics?`) for more details of this project. -Features: +This project is `the one of the most popular open-source software (OSS) in +the field of robotics on GitHub`_. +This graph shows star history of this project: -1. Easy to read for understanding each algorithm's basic idea. +.. image:: https://api.star-history.com/svg?repos=AtsushiSakai/PythonRobotics&type=Date + :alt: Star History + :align: center -2. Widely used and practical algorithms are selected. -3. Minimum dependency. - -See this paper for more details: - -- `[1808.10703] PythonRobotics: a Python code collection of robotics - algorithms`_ (`BibTeX`_) - - -.. _`[1808.10703] PythonRobotics: a Python code collection of robotics algorithms`: https://arxiv.org/abs/1808.10703 -.. _BibTeX: https://github.com/AtsushiSakai/PythonRoboticsPaper/blob/master/python_robotics.bib .. _GitHub: https://github.com/AtsushiSakai/PythonRobotics +.. _`MIT license`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/LICENSE +.. _`the one of the most popular open-source software (OSS) in the field of robotics on GitHub`: https://github.com/topics/robotics .. toctree:: :maxdepth: 2 - :caption: Contents + :caption: Table of Contents getting_started modules/introduction From 813013e8d97fcc5d124ed4760176ffb091706e3d Mon Sep 17 00:00:00 2001 From: Atsushi Sakai Date: Sun, 26 Jan 2025 21:57:52 +0900 Subject: [PATCH 2/2] update head doc --- docs/getting_started_main.rst | 4 ++++ docs/index_main.rst | 10 +++++++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/getting_started_main.rst b/docs/getting_started_main.rst index bf9f265c53..db71960dcf 100644 --- a/docs/getting_started_main.rst +++ b/docs/getting_started_main.rst @@ -10,6 +10,8 @@ What is PythonRobotics? This is an Open Source Software (OSS) project: PythonRobotics, which is a Python code collection of robotics algorithms. +This is developped under `MIT license`_ and on `GitHub`_. + 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. In this project, the algorithms which are practical and widely used in both academia and industry are selected. @@ -18,6 +20,8 @@ Each sample code is written in Python3 and only depends on some standard modules It includes intuitive animations to understand the behavior of the simulation. +.. _GitHub: https://github.com/AtsushiSakai/PythonRobotics +.. _`MIT license`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/LICENSE Features: diff --git a/docs/index_main.rst b/docs/index_main.rst index c4e46d1473..8c967ac59e 100644 --- a/docs/index_main.rst +++ b/docs/index_main.rst @@ -6,24 +6,28 @@ Welcome to PythonRobotics's documentation! ========================================== -"PythonRobotics" is a Python code collections and html based text book (This document) for robotics algorithm. -This is an open source software under `MIT license`_ and developed on `GitHub`_. +"PythonRobotics" is a Python code collections and html based text book +(This document) for robotics algorithm, which is developed on `GitHub`_. See this section (:ref:`What is PythonRobotics?`) for more details of this project. This project is `the one of the most popular open-source software (OSS) in the field of robotics on GitHub`_. -This graph shows star history of this project: +This is `user comments about this project`_, and +this graph shows GitHub star history of this project: .. image:: https://api.star-history.com/svg?repos=AtsushiSakai/PythonRobotics&type=Date :alt: Star History + :width: 80% :align: center .. _GitHub: https://github.com/AtsushiSakai/PythonRobotics +.. _`user comments about this project`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/users_comments.md .. _`MIT license`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/LICENSE .. _`the one of the most popular open-source software (OSS) in the field of robotics on GitHub`: https://github.com/topics/robotics +---------------------------------- .. toctree:: :maxdepth: 2