Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate user documentation away from Doxygen #540

Open
traversaro opened this issue Feb 24, 2021 · 0 comments
Open

Migrate user documentation away from Doxygen #540

traversaro opened this issue Feb 24, 2021 · 0 comments

Comments

@traversaro
Copy link
Member

Doxygen documentation is not really accessible for most users, so it probably make sense to move documentation that want to use the plugins to another system, while keeping doxygen for people that want to check documentation of function signature or that kind of aspects.

In my opinion, a good trade-off between user friendly and low maintenance is just to write nicely written README.md for each plugin, as done for example for the gazebo_yarp_robotinterface in https://github.com/robotology/gazebo-yarp-plugins/tree/master/plugins/robotinterface, and link them from the main README. This also gives for free version selection by setting the tag in the branch/tag selector of GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant