Doc charts #88
Merged
Doc charts #88
Conversation
This file contains 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
…in the top level index.
…ript. - Remove xsim run support from the doc_python script
ed-xmos
reviewed
Sep 26, 2023
doc/python/README.txt
Outdated
| Tests are run for all suported input and output sample freqencies, and for worst case frequency deviation. | ||
| Note that not all modules support all input scenarios - these are ignored. | ||
|
|
||
| The result of this script is the generation an rst file which is inclorporated into the documentation, |
There was a problem hiding this comment.
inclorporated -> incorporated.
Also incorporated twice is a bit clunky.
ed-xmos
reviewed
Sep 26, 2023
ed-xmos
approved these changes
Sep 26, 2023
|
Actually one more comment - might be better to zip the image artefacts. Jenkins artefacts page is pretty cluttered. |
added 2 commits
September 28, 2023 11:13
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
https://xmosjira.atlassian.net/browse/AP-149
In this PR I've added the doc charts generation script to run on Jenkins and archive the output plots in the artifacts.
Next step would be to add the plots to the documentation.