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
+7-12
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@ These tutorials use the [reStructuredText](http://www.sphinx-doc.org/en/stable/r
10
10
11
11
All content in this repository is open source and released under the [BSD License v3](https://opensource.org/licenses/BSD-3-Clause). Each individual source code file should contain a copy of the license.
12
12
13
-
This repository is currently built automatically by two systems. Travis builds the documentation for Melodic and ROS Build Farm builds the documentation for older versions:
13
+
This repository is currently built automatically by Github Actions:
An issue has been created for each tutorial to be ported to Foxy. At the top of each tutorial there is a tag: ":moveit1:", remove the tag
@@ -51,8 +51,7 @@ Configure and build the workspace:
51
51
52
52
## Build HTML Pages Locally
53
53
54
-
If you want to test the tutorials by generating the html pages locally on your machine, you will first need to build the `rosdoc_lite` and `genmsg` packages from source (they are included in the moveit2_tutorials.repos file), and then you can use the ``build_locally`` script.
55
-
Run in the root of the moveit2_tutorials package:
54
+
If you want to test the tutorials by generating the html pages locally on your machine, you can use the ``build_locally`` script by issuing the following commands in the root of the moveit2_tutorials package:
56
55
57
56
export ROS_DISTRO=foxy # 20.04
58
57
@@ -62,10 +61,6 @@ Run in the root of the moveit2_tutorials package:
62
61
63
62
The local website ``<LOCAL_PACKAGE_PATH>/build/html/index.html`` should automatically open in your web browser.
64
63
65
-
## ROS Build Farm Deployment
66
-
67
-
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).
68
-
69
64
## Contributing
70
65
71
66
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/moveit2_tutorials/issues/new) or open a PR with proposed changes.
@@ -120,7 +115,7 @@ moveit2_tutorials/doc/
120
115
│ └── <tutorial_name>/
121
116
│ └── <include_header>.h # Any custom C++ library header files
122
117
├── launch/
123
-
│ └── <tutorial_name>_tutorial.launch
118
+
│ └── <tutorial_name>_tutorial.launch.py
124
119
├── src/
125
120
│ ├── <tutorial_name>_tutorial.cpp # Main C++ executable
126
121
│ ├── <include_source>.cpp # Custom C++ library source files
@@ -129,7 +124,7 @@ moveit2_tutorials/doc/
129
124
│ ├── <tutorial_name>_tutorial.py # Main Python executable
0 commit comments