【ROS總結】發佈ROS1包之文檔編寫

前言

在上一節中,講述瞭如何發佈一個包到ROS社區,這一節將講述,如何在wiki界面編寫ROS包說明文檔、教程。

步驟如下:

  1. 登錄wiki官網,創建界面編輯賬號
  2. 向ROS社區提交wiki頁面編輯權限,取得白名單
  3. 編輯ROS包文檔

創建wiki賬號

登錄wiki.ros.org,選擇登錄,創建賬戶

輸入用戶名密碼

創建完成後,選擇登錄,登錄成功會將顯示:

點擊界面獲取白名單。

wiki白名單

在github上,登錄當前github賬號,在白名單註冊界面:https://github.com/ros-infrastructure/roswiki/issues/139

發佈請求,比如我的wiki用戶爲playfish,輸入,comment即可。


如果一切正常,大家可以登錄http://wiki.ros.org/UserGroup,查看自己的名字是否加入。

編輯文檔

現在編寫自己ROS包的使用文檔,該文檔地址應當在package.xml裏面表明,比如我的cht10_node包的package.xml地址爲:

因此,輸入當前第一個網址 http://ros.org/wiki/cht10_node

點擊packageTemplate,來創建界面。


在packageHeader中添加自己的cht10_node包名,該界面會自動鏈接到cht10_node包。

創建完成後,即可生成界面,文檔編輯結束。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章