docs: add API documentation for benchmarking #21
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Elizabeth J Lee <elizabeth.j.lee@intel.com>
Brian-McGinn
approved these changes
May 7, 2024
Dockerfile.docs
Outdated
| rm -rf /var/lib/apt/lists/* | ||
|
|
||
| WORKDIR /apis | ||
| RUN wget https://github.com/ejlee3/performance-tools/archive/refs/heads/add-sphinx.zip |
There was a problem hiding this comment.
should we put this on the normal git instead of yours?
Contributor
Author
There was a problem hiding this comment.
yes - I need to merge the other PR first, then we can do this, but I left it this way for now so that people can try it out and make sure it works for them too.
Signed-off-by: Elizabeth J Lee <elizabeth.j.lee@intel.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
What requirement is this design document for?
#issue_number
Anything the reviewer should know when reviewing this PR?
This only works when using Docker to build and serve the docs.
Run
make serve-docsand look at the benchmarking API page.If there are any other design Pull Requests or requirements, please link them here (i.e. intel-retail/automated-self-checkout )
Related PR for API doc changes: intel-retail/performance-tools#46 (needs to be merged first)