Skip to content

Commit f5d80ec

Browse files
authored
remove old doc links (AtsushiSakai#677)
* remove old doc links * add github link * add github link * add github link
1 parent b01128a commit f5d80ec

5 files changed

+16
-6
lines changed

.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
Thanks for contributing a pull request!
33
Please check this document before submitting:
4-
- [How to contribute](https://pythonrobotics.readthedocs.io/en/latest/how_to_contribute.html#adding-a-new-algorithm-example)
4+
- [How to contribute](https://atsushisakai.github.io/PythonRobotics/how_to_contribute.html#adding-a-new-algorithm-example)
55
66
Note that this is my hobby project; I appreciate your
77
patience during the review process.

README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
![GitHub_Action_Linux_CI](https://github.com/AtsushiSakai/PythonRobotics/workflows/Linux_CI/badge.svg)
55
![GitHub_Action_MacOS_CI](https://github.com/AtsushiSakai/PythonRobotics/workflows/MacOS_CI/badge.svg)
66
[![Build status](https://ci.appveyor.com/api/projects/status/sb279kxuv1be391g?svg=true)](https://ci.appveyor.com/project/AtsushiSakai/pythonrobotics)
7-
[![Documentation Status](https://readthedocs.org/projects/pythonrobotics/badge/?version=latest)](https://pythonrobotics.readthedocs.io/en/latest/?badge=latest)
87
[![codecov](https://codecov.io/gh/AtsushiSakai/PythonRobotics/branch/master/graph/badge.svg)](https://codecov.io/gh/AtsushiSakai/PythonRobotics)
98
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/AtsushiSakai/PythonRobotics.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/AtsushiSakai/PythonRobotics/context:python)
109
[![tokei](https://tokei.rs/b1/github/AtsushiSakai/PythonRobotics)](https://github.com/AtsushiSakai/PythonRobotics)
@@ -126,7 +125,7 @@ This README only shows some examples of this project.
126125

127126
If you are interested in other examples or mathematical backgrounds of each algorithm,
128127

129-
You can check the full documentation online: [https://pythonrobotics.readthedocs.io/](https://pythonrobotics.readthedocs.io/)
128+
You can check the full documentation online: [Welcome to PythonRobotics’s documentation\! — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/index.html)
130129

131130
All animation gifs are stored here: [AtsushiSakai/PythonRoboticsGifs: Animation gifs of PythonRobotics](https://github.com/AtsushiSakai/PythonRoboticsGifs)
132131

@@ -609,7 +608,7 @@ This is a list of user's comment and references:[users\_comments](https://github
609608

610609
Any contribution is welcome!!
611610

612-
Please check this document:[How to contribute](https://pythonrobotics.readthedocs.io/en/latest/how_to_contribute.html#)
611+
Please check this document:[How To Contribute — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/how_to_contribute.html)
613612

614613
# Citing
615614

docs/conf.py

+11
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,17 @@
9595
'display_version': False,
9696
}
9797

98+
# replace "view page source" with "edit on github" in Read The Docs theme
99+
# * https://github.com/readthedocs/sphinx_rtd_theme/issues/529
100+
html_context = {
101+
'display_github': True,
102+
'github_user': 'AtsushiSakai',
103+
'github_repo': 'PythonRobotics',
104+
'github_version': 'master',
105+
"conf_py_path": "/docs/",
106+
"source_suffix": source_suffix,
107+
}
108+
98109
# Add any paths that contain custom static files (such as style sheets) here,
99110
# relative to this directory. They are copied after the builtin static files,
100111
# so a file named "default.css" will overwrite the builtin "default.css".

docs/how_to_contribute_main.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Sponsors
147147
1. `JetBrains`_ : They are providing a free license of their IDEs for this OSS development.
148148

149149

150-
.. _`Python Robotics Docs`: https://pythonrobotics.readthedocs.io/en/latest/
150+
.. _`Python Robotics Docs`: https://atsushisakai.github.io/PythonRobotics
151151
.. _`bug labeled issues`: https://github.com/AtsushiSakai/PythonRobotics/issues?q=is%3Aissue+is%3Aopen+label%3Abug
152152
.. _`tests dir`: https://github.com/AtsushiSakai/PythonRobotics/tree/master/tests
153153
.. _`test_a_star.py`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/tests/test_a_star.py

users_comments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This is an electric wheelchair control demo by [Katsushun89](https://github.com/
66

77
[WHILL Model CR](https://whill.jp/model-cr) is the control target, [M5Stack](https://m5stack.com/) is used for the controller, and [toio](https://toio.io/) is used for the control input device.
88

9-
[move-to-a-pose-control](https://pythonrobotics.readthedocs.io/en/latest/modules/path_tracking.html#move-to-a-pose-control) is used for its control algorithm ([code link](https://github.com/AtsushiSakai/PythonRobotics/blob/master/PathTracking/move_to_pose/move_to_pose.py)).
9+
[Move to a Pose Control — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/modules/control/move_to_a_pose_control/move_to_a_pose_control.html) is used for its control algorithm ([code link](https://github.com/AtsushiSakai/PythonRobotics/blob/master/PathTracking/move_to_pose/move_to_pose.py)).
1010

1111
![1](https://github.com/AtsushiSakai/PythonRoboticsGifs/blob/master/Users/WHILL_Model_CR_with_move_to_a_pose/WHLL_Model_CR_with_move_to_a_pose.gif)
1212

0 commit comments

Comments
 (0)