github/PythonRobotics
1
1
Fork 0
mirror of https://github.com/AtsushiSakai/PythonRobotics.git synced 2026-04-22 03:00:22 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: enhance contribution guide with instructions for linking code in GitHub (#1202)

Browse Source
This commit is contained in:
Atsushi Sakai
2025-04-28 08:51:09 +09:00
committed by GitHub
parent 764ba21f86
commit 1c1596be21
3 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/modules/0_getting_started/3_how_to_contribute_main.rst
View File

@@ -107,6 +107,18 @@ mathematics and the algorithm of the example.
Documentations related codes should be in the python script as the header
comments of the script or docstrings of each function.
Also, each document should have a link to the code in Github.
You can easily add the link by using the `.. autoclass::`, `.. autofunction::`, and `.. automodule` by Sphinx's `autodoc`_ module.
Using this `autodoc`_ module, the generated documentations have the link to the code in Github like:
.. image:: /_static/img/source_link_1.png
When you click the link, you will jump to the source code in Github like:
.. image:: /_static/img/source_link_2.png
.. _`submit a pull request`:
@@ -210,5 +222,6 @@ Current Major Sponsors:
.. _`1Password`: https://github.com/1Password/for-open-source
.. _`matplotrecorder`: https://github.com/AtsushiSakai/matplotrecorder
.. _`PythonRoboticsGifs`: https://github.com/AtsushiSakai/PythonRoboticsGifs
.. _`autodoc`: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html