Skip to content

Commit 52f8caf

Browse files
committed
fix: correct terminology in documentation and update Sphinx options
1 parent 8064488 commit 52f8caf

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33

44
# You can set these variables from the command line.
5-
SPHINXOPTS =
5+
SPHINXOPTS = -W
66
SPHINXBUILD = sphinx-build
77
SPHINXPROJ = PythonRobotics
88
SOURCEDIR = .

docs/modules/0_getting_started/3_how_to_contribute_main.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ If you would like to support us in some other way, please contact with creating
187187

188188
Current Major Sponsors:
189189

190+
#. `GitHub`_ : They are providing a GitHub Copilot Pro license for this OSS development.
190191
#. `JetBrains`_ : They are providing a free license of their IDEs for this OSS development.
191192
#. `1Password`_ : They are providing a free license of their 1Password team license for this OSS project.
192193

@@ -202,6 +203,7 @@ Current Major Sponsors:
202203
.. _`doc README`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/docs/README.md
203204
.. _`test_codestyle.py`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/tests/test_codestyle.py
204205
.. _`JetBrains`: https://www.jetbrains.com/
206+
.. _`GitHub`: https://www.github.com/
205207
.. _`Sponsor @AtsushiSakai on GitHub Sponsors`: https://github.com/sponsors/AtsushiSakai
206208
.. _`Become a backer or sponsor on Patreon`: https://www.patreon.com/myenigma
207209
.. _`One-time donation via PayPal`: https://www.paypal.com/paypalme/myenigmapay/

docs/modules/1_introduction/1_definition_of_robotics/definition_of_robotics_main.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,4 @@ Robotics consists of several essential components:
104104
#. Software & Algorithms – Allow the robot to function and make intelligent decisions (e.g., ROS, Machine learning models, Localization, Mapping, Path planning, Control).
105105

106106
This project, `PythonRobotics`, focuses on the software and algorithms part of robotics.
107-
If you are interested in `Sensors` hardware, you can check :ref:`Internal Sensors for Robotics`_ or :ref:`External Sensors for Robotics`_.
107+
If you are interested in `Sensors` hardware, you can check :ref:`Internal Sensors for Robots` or :ref:`External Sensors for Robots`.

0 commit comments

Comments
 (0)