Skip to content

Commit 4261d64

Browse files
Vatan Aksoy Tezertylerjw
Vatan Aksoy Tezer
andauthored
Fix CI badges and cleanup rosdoc documentation (#78)
* Fix badges and cleanup rosdoc documentation * Fix tutorial repo in getting started * Update README with better badge links Co-authored-by: Tyler Weaver <[email protected]> Co-authored-by: Tyler Weaver <[email protected]>
1 parent 64320dd commit 4261d64

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

README.md

+7-12
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ These tutorials use the [reStructuredText](http://www.sphinx-doc.org/en/stable/r
1010

1111
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.
1212

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:
1414

15-
- [![Build](https://github.com/ros-planning/moveit2_tutorials/actions/workflows/industrial_ci_action.yml/badge.svg?branch=main)](https://travis-ci.com/ros-planning/moveit2_tutorials) [Tutorials + Github Actions](https://moveit2_tutorials.picknik.ai/): Latest (Foxy, MoveIt 2)
16-
- [![Format](https://github.com/ros-planning/moveit2_tutorials/actions/workflows/format.yml/badge.svg?branch=main)](https://travis-ci.com/ros-planning/moveit2_tutorials) [Format + Github Actions](https://moveit2_tutorials.picknik.ai/): Latest (Foxy, MoveIt 2)
17-
- [![CheckBuildHTML](https://github.com/ros-planning/moveit2_tutorials/actions/workflows/htmlcheck.yml/badge.svg?branch=main)](https://travis-ci.com/ros-planning/moveit2_tutorials) [Github Pages + Github Actions](https://moveit2_tutorials.picknik.ai/): Latest (Foxy, MoveIt 2)
15+
- [![Build](https://github.com/ros-planning/moveit2_tutorials/actions/workflows/industrial_ci_action.yml/badge.svg?branch=main)](https://github.com/ros-planning/moveit2_tutorials/actions/workflows/industrial_ci_action.yml?query=branch%3Amain) [Tutorials + Github Actions](https://moveit2_tutorials.picknik.ai/): Latest (Foxy, MoveIt 2)
16+
- [![Format](https://github.com/ros-planning/moveit2_tutorials/actions/workflows/format.yml/badge.svg?branch=main)](https://github.com/ros-planning/moveit2_tutorials/actions/workflows/format.yml?query=branch%3Amain) [Format + Github Actions](https://moveit2_tutorials.picknik.ai/): Latest (Foxy, MoveIt 2)
17+
- [![Deploy](https://github.com/ros-planning/moveit2_tutorials/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/ros-planning/moveit2_tutorials/actions/workflows/deploy.yml?query=branch%3Amain) [Github Pages + Github Actions](https://moveit2_tutorials.picknik.ai/): Latest (Foxy, MoveIt 2)
1818

1919
## Getting Started
2020
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:
5151

5252
## Build HTML Pages Locally
5353

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:
5655

5756
export ROS_DISTRO=foxy # 20.04
5857

@@ -62,10 +61,6 @@ Run in the root of the moveit2_tutorials package:
6261

6362
The local website ``<LOCAL_PACKAGE_PATH>/build/html/index.html`` should automatically open in your web browser.
6463

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-
6964
## Contributing
7065

7166
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/
120115
│ └── <tutorial_name>/
121116
│ └── <include_header>.h # Any custom C++ library header files
122117
├── launch/
123-
│ └── <tutorial_name>_tutorial.launch
118+
│ └── <tutorial_name>_tutorial.launch.py
124119
├── src/
125120
│ ├── <tutorial_name>_tutorial.cpp # Main C++ executable
126121
│ ├── <include_source>.cpp # Custom C++ library source files
@@ -129,7 +124,7 @@ moveit2_tutorials/doc/
129124
│ ├── <tutorial_name>_tutorial.py # Main Python executable
130125
│ └── <python_library>.py # Custom Python libraries
131126
└── test/ # Ideally tutorials have their own integration tests
132-
├── <tutorial_name>_tutorial.test # Launch file for tests
127+
├── <tutorial_name>_tutorial.test.py # Launch file for tests
133128
├── <tutorial_name>_tutorial_test.py # Python tests for tutorial
134129
└── <tutorial_name>_tutorial_test.cpp # C++ tests for tutorial
135130
```

doc/getting_started/getting_started.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ You will need to have a `colcon <https://docs.ros.org/en/foxy/Tutorials/Colcon-T
3636

3737
wget https://raw.githubusercontent.com/ros-planning/moveit2/main/moveit2.repos
3838
vcs import < moveit2.repos
39-
wget https://raw.githubusercontent.com/ros-planning/moveit2/main/moveit2.repos
40-
vcs import < moveit2.repos
39+
wget https://raw.githubusercontent.com/ros-planning/moveit2_tutorials/main/moveit2_tutorials.repos
40+
vcs import < moveit2_tutorials.repos
4141

4242
Build your Colcon Workspace
4343
^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)