Giter VIP home page Giter VIP logo

ros.org.docset's Introduction

ros.org.docset

This repository contains a docset for the Robot Operating System (ROS). It can be used with Zeal or Dash

Usage

Here is explained how you can add the ROS docset to your docsets

Feed URL

https://raw.githubusercontent.com/famalgosner/ros.org.docset/master/ROS.xml

Zeal

Start Zeal and open the Docsets setting (Tools --> Docsets...).
After all docsets have been updated, click the button Add feed.
Add this Feed URL and the docset will be downloaded. Future updates will be installed automatically.

Dash

Start Dash and open the preferences.
Navigate to Downloads and click on the Plus-Symbol on the bottom.
Add the Feed URL and you are ready to go.

Included documentations

  • actionlib
  • geometry
  • geometry2
  • image_common
  • ros
  • ros_comm
  • ros_control
  • roscpp_core
  • vision_opencv

Credits

Credits go to

  • all contributors of ROS and its documentations
  • Ved Vyas for doxytag2zealdb

Build your own docset

There is some nice documentation for building your own docset on the official page here Dash - Docset Generation Guide

To build a docset containing ROS packages you can follow these steps.

  1. Check out all repositories you want to add into a folder
  2. Run doxygen Doxyfile inside the folder. The Doxyfile can be found in this repository. Place in the same folder next to all the ros packages
  3. Change into html directory
  4. Run make
  5. Now doxygen builds some things and will end with an error as some OSX dependencies are missing. But everything else is fine
  6. Run python -m doxytag2zealdb --tag ../ROS.tag --db ROS.docset/Contents/Resources/docSet.dsidx --include-parent-scopes --include-function-signatures
  • This will create and fill the SQLite3 database based on the tags created by doxygen
  1. Optional: You can add a logo.png by copying some logo to the root directory of the docset.
  2. Copy the ROS.docset folder to the documentation browser library. With Zeal and Linux it is ~/.local/share/Zeal/Zeal/docsets
  3. You are done :-)

ros.org.docset's People

Contributors

beckerpascal avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

ros.org.docset's Issues

not working on dash

hey,
this is not working in dash.
with the "+" sign I get a menu with different types of sources.
I can only add it as a github repo, but the ros.org info is not there.
??

Provide a reproducable way to generate the docset

Can you add documentation or a script for how to generate the docset to allow people to extend support or suggest contributions and to make it obvious what's inside and not inside besides via the readme.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.