reference-system icon indicating copy to clipboard operation
reference-system copied to clipboard

use docs hosting site to host html reports

Open flynneva opened this issue 4 years ago • 3 comments

would be nice to auto-generate some documents, add them to a github pages site and have a page / folder for people to add their auto-generated .html reports.

  • [x] choose a docs generation approach for the code (doxygen most likely candidate)
  • [x] update comments in code to match docs framework requirements
  • [x] generate some docs
  • [x] host it on github pages
  • [x] add version selector to docs so that we can track results over time / versions of executors
  • [ ] add instructions on how to contribute results if desired
  • [x] upload ~~.html~~ .md reports as individual pages on docs site
    • [ ] add sub-folders for different platforms

flynneva avatar Oct 19 '21 20:10 flynneva

this also would allow closed-source contributors to share their results for others to see in one central location

flynneva avatar Oct 19 '21 20:10 flynneva

For others reference, there now exists the ros2_realtime_benchmarks repo that will host more than just the reference_system reports.

I think adding a link to this site within the docs of this repo will be sufficient to complete this issue.

flynneva avatar Apr 30 '22 16:04 flynneva

Slight change to this: we should adjust the reporting scripts to generate markdown files with html embedded in them as the figures, similar to what performance_report does

flynneva avatar May 06 '22 23:05 flynneva