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

use docs hosting site to host html reports #75

Open
6 of 8 tasks
flynneva opened this issue Oct 19, 2021 · 3 comments
Open
6 of 8 tasks

use docs hosting site to host html reports #75

flynneva opened this issue Oct 19, 2021 · 3 comments
Assignees
Labels
benchmarks documentation Improvements or additions to documentation

Comments

@flynneva
Copy link
Collaborator

flynneva commented Oct 19, 2021

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.

  • choose a docs generation approach for the code (doxygen most likely candidate)
  • update comments in code to match docs framework requirements
  • generate some docs
  • host it on github pages
  • 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
  • upload .html .md reports as individual pages on docs site
    • add sub-folders for different platforms
@flynneva
Copy link
Collaborator Author

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

@flynneva
Copy link
Collaborator Author

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
Copy link
Collaborator Author

flynneva commented May 6, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
benchmarks documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

2 participants