-
Notifications
You must be signed in to change notification settings - Fork 44
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
Publish HTML docs for 1.1 RTL in addition to main #676
base: main
Are you sure you want to change the base?
Conversation
Not sure what I'm supposed to do to bypass the test timestamp, since this is a documentation-only change:
|
Thanks for doing this Jordan, nice improvement!
|
Also, a topic for discussion in the WG: Do we go back and retroactively update the README from patch_v1.1 to point to these new pages? |
@jhand2 I've commited some updates to the pre-run-check workflow (added the exclusions I proposed above). |
Thanks! Done. |
Currently the docs workflow only publishes documentation for registers at main. To make it easier to look up registers for 1.x, also publish the registers from the patch_v1.1 branch.
path: /tmp/pages-docs/v1_1 | ||
|
||
- name: Generate GitHub Pages artifacts | ||
uses: actions/upload-pages-artifact@v1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this needs to be v3
@@ -52,3 +52,4 @@ For each release, the following steps are followed to ensure code functionality | |||
- Add latest synthesis results to the [CaliptraIntegrationSpecification](./CaliptraIntegrationSpecification.md#netlist-synthesis-data) | |||
- Update [Release_Notes](../Release_Notes.md) | |||
- Tag the main branch on GitHub to generate an official release | |||
- Generate version-specific registers documentation page in in The [Register Documentation Workflow](./.github/workflows/doc-gen.yml) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: in in The
-> in the
Couple minor comments. |
#704 is merged. Can you address the above comments and rebase this PR to |
Currently the docs workflow only publishes documentation for registers at main. To make it easier to look up registers for 1.x, also publish the registers from the patch_v1.1 branch.
This was tested on my fork of this repo. See sample output: