Doxygen generated documentation is outdated about robot-testing-framework HOT 8 CLOSED

+1 for documenting YARP rtf plugins in YARP docs.

from robot-testing-framework.

For the time being, I added a script for updating the doxygen documentation and uploading it automatically to Gitlab Pages in the https://gitlab.com/robotology/docs . It is a bit of an experiment, but it is working fine:

• master branch: http://robotology.gitlab.io/docs/rtf/master/
• devel branch: http://robotology.gitlab.io/docs/rtf/devel/

from robot-testing-framework.

I updated the documentation in icub-tests(PR robotology/icub-tests#36), but I think we should add a section in yarp documentation about rtf plugins (if it is not already present) and then add references to it in icub-tests and rtf documentation.
What do you think about it?

from robot-testing-framework.

It should be sufficient to use the local gh-pages branch to generate the documentation, or even better we could put in place the automatic mechanism that relies on travis CI to produce the doxygen and push to GitHub.

..with cron jobs that automatically re-generate the doxy every week (or every day) even if nobody committed to the repo 😁

FYI I love Travis CI's cron jobs! They saved me a lot of headaches down the road.

from robot-testing-framework.

cc @Nicogene

from robot-testing-framework.

@traversaro cool, I didn't know we had a group on gitlab as well :)

from robot-testing-framework.

It should be sufficient to use the local gh-pages branch to generate the documentation, or even better we could put in place the automatic mechanism that relies on travis CI to produce the doxygen and push to GitHub.

Thanks to @francesco-romano, we have instructions for this available here: how-to-document-modules/auto_doc.

from robot-testing-framework.

solved by #73

from robot-testing-framework.