You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ This repository is currently built automatically by two systems. Github Actions
25
25
26
26
## Build Locally
27
27
28
-
If you want to test the tutorials by generating the html pages locally on your machine, you can use the ``build_locally`` script.
28
+
If you want to test the tutorials by generating the HTML pages locally on your machine, you can use the ``build_locally`` script.
29
29
Run in the root of the moveit_tutorials package:
30
30
31
31
export ROS_DISTRO=kinetic # 16.04
@@ -39,20 +39,20 @@ The local website ``<LOCAL_PACKAGE_PATH>/build/html/index.html`` should automati
39
39
40
40
## ROS Build Farm Deployment
41
41
42
-
For deploying documentation changes to the web, [Section 3 of rosdoc_lite wiki](http://wiki.ros.org/rosdoc_lite) says that "rosdoc_lite is automatically run for packages in repositories that have rosinstall files listed in the rosdistro repository." This is done about once every 24 hours, [overnight](http://wiki.ros.org/rosdistro/Tutorials/Indexing%20Your%20ROS%20Repository%20for%20Documentation%20Generation).
42
+
For deploying documentation changes to the web, [Section 3 of the rosdoc_lite wiki](http://wiki.ros.org/rosdoc_lite) says that "rosdoc_lite is automatically run for packages in repositories that have rosinstall files listed in the rosdistro repository." This is done about once every 24 hours, [overnight](http://wiki.ros.org/rosdistro/Tutorials/Indexing%20Your%20ROS%20Repository%20for%20Documentation%20Generation).
43
43
44
44
## Contributing
45
45
46
-
We rely on the community to keep these tutorials up to date and bugfree. If you find an issue with the tutorials please [open an issue on GitHub](https://github.com/ros-planning/moveit_tutorials/issues/new) or open a PR with proposed changes.
46
+
We rely on the community to keep these tutorials up-to-date and bug-free. If you find an issue with the tutorials please [open an issue on GitHub](https://github.com/ros-planning/moveit_tutorials/issues/new) or open a PR with the proposed changes.
47
47
48
48
### Formatting and Style
49
49
50
50
**Code Formatting**
51
51
52
-
* These tutorials use the same [style guidelines](http://moveit.ros.org/documentation/contributing/code/) as the MoveIt project. When modifying or adding to these tutorials, it is required that code is autoformatted using [clang-format](http://moveit.ros.org/documentation/contributing/code/). To check and apply our style guidelines we use [pre-commit](https://pre-commit.com/).
52
+
* These tutorials use the same [style guidelines](http://moveit.ros.org/documentation/contributing/code/) as the MoveIt project. When modifying or adding to these tutorials, it is required that code is auto-formatted using [clang-format](http://moveit.ros.org/documentation/contributing/code/). To check and apply the style guidelines we use [pre-commit](https://pre-commit.com/).
53
53
* Tutorials should exemplify best coding practices. If a contribution wouldn't pass review in the MoveIt project, then it shouldn't pass review in the tutorials.
54
54
* Relevant code should be included and explained using the ``.. tutorial-formatter::`` tag.
55
-
* Irrelevant code should be excluded from the generated html using the ``BEGIN_TUTORIAL``, ``END_TUTORIAL``, ``BEGIN_SUB_TUTORIAL``, and ``END_SUB_TUTORIAL`` tags.
55
+
* Irrelevant code should be excluded from the generated HTML using the ``BEGIN_TUTORIAL``, ``END_TUTORIAL``, ``BEGIN_SUB_TUTORIAL``, and ``END_SUB_TUTORIAL`` tags.
56
56
* Whenever possible, links should be created using the ``extlinks`` dictionary defined in ``conf.py``.
57
57
* All demo code should be runnable from within the ``moveit_tutorials`` package.
58
58
* Python code should be run using ``rosrun``.
@@ -61,19 +61,19 @@ We rely on the community to keep these tutorials up to date and bug free. If you
61
61
62
62
* Each tutorial should be focused on teaching the user one feature or interface within MoveIt.
63
63
* Tutorials should flow from show to tell with videos and demos at the beginning followed by explanations.
64
-
* New tutorials should match the formatting, style and flow of existing tutorials whenever possible.
64
+
* New tutorials should match the formatting, style, and flow of existing tutorials whenever possible.
65
65
66
66
**pre-commit**
67
67
68
68
pre-commit is a tool that is used in ``moveit_tutorials`` to check and apply style guidelines automatically. To install pre-commit into your system:
69
69
70
70
pip3 install pre-commit
71
71
72
-
In you catkin workspace, under ``moveit_tutorials`` directory you can install the git hooks like this:
72
+
In your catkin workspace, under the``moveit_tutorials`` directory you can install the git hooks like this:
73
73
74
74
cd $CATKIN_WS/src/moveit_tutorials && pre-commit install
75
75
76
-
With this pre-commit will automatically run and check a list of styling including clang-format, end of files and trailing whitespaces whenever you run ``git commit``. To run pre-commit any time other than ``git commit`` you can use the following command:
76
+
With this pre-commit will automatically run and check a list of styling including clang-format, end of files, and trailing whitespaces whenever you run ``git commit``. To run a pre-commit at any time other than ``git commit`` you can use the following command:
77
77
78
78
cd $CATKIN_WS/src/moveit_tutorials && pre-commit run -a
79
79
@@ -122,21 +122,21 @@ This assumes that `filename.png` is in the same folder as the source `.rst` file
Do **not** include animated gifs as the file format leads to very large files. Use a video format like `webm` and see the section on local video below.
125
+
Do **not** include animated gifs as the file format leads to very large files. Use a video format like `webm` and see the section on the local video below.
126
126
127
127
#### YouTube and other External Video
128
-
You can embed video with raw html, like in this example from the Pick and Place Tutorial.
128
+
You can embed video with raw HTML, like in this example from the Pick and Place Tutorial.
0 commit comments