gazebosim / gazebosim/sdformat

Create XML style sheet to display SDF

Open
#134 0 comments 0 reactions 0 assignees View on GitHub
enhancement minor
Dominant language
C++
Stars
216
Forks
125
Avg merge
1d 14h
Merged PRs (30d)
14

Description

**Original report ([archived issue](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/issues/134)) by Nate Koenig (Bitbucket: [Nathan Koenig](https://bitbucket.org/%7Bc862cdd9-fcc8-4419-9fc7-e20db14b8fcb%7D/)).**

----------------------------------------
Similar to the [Google style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml), create an XML style sheet to display documented SDF. This would avoid the need to compile and run `gzsdf` to produce docs for SDF. Replaces #27.

Moved from [gazebo issue #226](https://bitbucket.org/osrf/gazebo/issues/226).

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the archived report, the linked Google XML style guide, and how gzsdf currently produces SDF documentation. Define the stylesheet's expected input and output before implementing it. Done means documented SDF can be displayed through the stylesheet without compiling and running gzsdf.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.