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.

Sign up for GitHub

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

Jump to bottom

documentation #14

Open
asmodehn opened this issue Aug 22, 2017 · 5 comments
Open

documentation #14

asmodehn opened this issue Aug 22, 2017 · 5 comments
Assignees
@AlexReimann

Comments

@asmodehn
Copy link
Member

We need to generate documentation with :

  • rosdoc for all ros packages
  • readthedocs (pure sphinx) with ros1_pytemplate and ros1_pip_pytemplate
@asmodehn
Copy link
Member Author

started in #21

giving up the readthedocs idea (keep it for pyros-template)

Still need to do the c++ doc. @AlexReimann

@AlexReimann AlexReimann self-assigned this Aug 29, 2017
@AlexReimann
Copy link
Collaborator

I think using sphinx for python and doxygen + markdown for cpp is the way to go..

Doxygen only works with markdown and according to the rosdoc wiki only Doxygen is 'advised' for C++

@AlexReimann
Copy link
Collaborator

Still not in the wiki and we are gray on jenkins hmm...

@asmodehn
Copy link
Member Author

asmodehn commented Aug 31, 2017 •
edited
Loading

The wiki is manual. but we are also not in http://docs.ros.org/api/...

@asmodehn
Copy link
Member Author

Latest doc generated there is from 28-Aug. Also they are currently migrating the buildfarm to xenial, so that maybe related...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AlexReimann AlexReimann

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@asmodehn @AlexReimann