[doc] Update links to latest IP regression results using a semi-automatic script#29425
Open
etterli wants to merge 2 commits intolowRISC:masterfrom
Open
[doc] Update links to latest IP regression results using a semi-automatic script#29425etterli wants to merge 2 commits intolowRISC:masterfrom
etterli wants to merge 2 commits intolowRISC:masterfrom
Conversation
This adds the script mdbook_regression_links.py which does update the links to the regressions of the IP blocks. As there is currently no 'latest' link, we hardcode it to the latest weekly regression results of Earl Grey. This linking should be cleaned up once we have a 'latest' link. Signed-off-by: Pascal Etterli <pascal.etterli@lowrisc.org>
etterli
force-pushed
the
doc-regression-link
branch
from
17ea1c5 to
9c43afa
Compare
nasahlpa
reviewed
Mar 9, 2026
Member
nasahlpa
left a comment
nasahlpa
left a comment
There was a problem hiding this comment.
Thanks for this PR, Pascal! Good to have a pointer to the latest regression run in the documentation.
CI is currently failing as you also need to check-in the auto-generated files for Darjeeling and Englishbreakfast.
This updates the regression links to the results from the 08-Mar-2026 Earl Grey regression. Signed-off-by: Pascal Etterli <pascal.etterli@lowrisc.org>
etterli
force-pushed
the
doc-regression-link
branch
from
9c43afa to
7a8a827
Compare
Contributor
Author
Yep, I've seen this. It is now updated. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This adds a script which can be run manually to update all links to regression results for almost all IP blocks.
Currently, the IP block documentation point to a relatively old regression run. This PR adds a script which let's update these links semi-automatically. One must run the script and then can commit the documentation update.
It touches all IPs under hw/ip/ which have regression results from the earlgrey weekly regression. It also includes some IPs from hw/ip_templates. But not all work (yet, this is a timeboxed task).
This is a temporary fix and should be reworked once we have a 'latest' link.
Here are two examples how this will look like (compare it with the current AES and entropy source):
The regression links point to https://nightly.reports.lowrisc.org/opentitan_weekly_earlgrey/2026_03_08/index.html. It is currently not possible to point directly to the IP report because the CSS is only loaded if the viewer first visits the
index.htmlpage (CSS is used to style the html). The badges however use the data directly from the report.The reference to the Earl Grey tapeout points to the IP documentation on the Earl Grey website https://opentitan.org/earlgrey_1.0.0/book/hw/ip/entropy_src/index.html