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

Documentation available on readthedocs.io #24

Open
Rayman opened this issue Nov 18, 2017 · 3 comments
Open

Documentation available on readthedocs.io #24

Rayman opened this issue Nov 18, 2017 · 3 comments

Comments

@Rayman
Copy link
Owner

Rayman commented Nov 18, 2017

Example: https://catkin-tools.readthedocs.io/en/latest/

@Rayman Rayman changed the title Documentation on readthedocs.io Documentation available on readthedocs.io Nov 18, 2017
@alberth
Copy link
Contributor

alberth commented Feb 5, 2018

Apparently, there is a mkdocs apt package available for this using Markdown syntax, see also http://www.mkdocs.org/

@reinzor
Copy link
Collaborator

reinzor commented Feb 6, 2018

This can also be realized using rosdoc

@alberth
Copy link
Contributor

alberth commented Feb 6, 2018

The rosdoc tool got a new name, it's rosdoc_lite nowadays, apparently, but both tools look complimentary in nature. mkdocs handles creation of the document-files of one project (markdown syntax in readthedocs style output), while rosdoc_lite seems to cover generation for several kinds of documentation generator across several ros-packages.

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

No branches or pull requests

3 participants