-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from chipsalliance/kor-docgen
Delete autogenerated register docs from repo and add workflow to generate them
- Loading branch information
Showing
461 changed files
with
65 additions
and
50,572 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# docs: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions | ||
|
||
name: Register Documentation | ||
|
||
on: | ||
workflow_dispatch: | ||
pull_request: | ||
push: | ||
branches: ["main"] | ||
|
||
jobs: | ||
build: | ||
name: Build | ||
|
||
runs-on: ubuntu-22.04 | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Install peakrd-uvm | ||
run: | | ||
python3 -m pip install \ | ||
peakrdl-uvm==2.2.0 \ | ||
peakrdl-regblock==0.10.0 \ | ||
peakrdl-html==2.9.0 \ | ||
peakrdl-ipxact==3.3.0 | ||
- name: Generate docs | ||
run: | | ||
echo Running script | ||
tools/scripts/reg_doc_gen.sh | ||
- name: Stage documents | ||
run: | | ||
mkdir -p /tmp/pages-docs/0.8 | ||
cp -R src/integration/docs/caliptra_reg_html /tmp/pages-docs/0.8/internal-regs | ||
cp -R src/soc_ifc/docs/caliptra_top_reg_html /tmp/pages-docs/0.8/external-regs | ||
find /tmp/pages-docs | ||
- name: Generate GitHub Pages artifacts | ||
uses: actions/upload-pages-artifact@v1 | ||
with: | ||
path: /tmp/pages-docs | ||
|
||
deploy: | ||
name: Deploy | ||
needs: build | ||
if: github.event_name == 'push' | ||
|
||
permissions: | ||
pages: write | ||
id-token: write | ||
|
||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
runs-on: ubuntu-22.04 | ||
|
||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v1 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
src/integration/docs/caliptra_reg_html/ | ||
src/soc_ifc/docs/caliptra_top_reg_html/ |
4 changes: 0 additions & 4 deletions
4
src/integration/docs/caliptra_reg_html/.launcher_data/firefox/user.js
This file was deleted.
Oops, something went wrong.
83 changes: 0 additions & 83 deletions
83
src/integration/docs/caliptra_reg_html/content/003e6f4d3661c51b1c10a9803fc659b4291f25e6.html
This file was deleted.
Oops, something went wrong.
79 changes: 0 additions & 79 deletions
79
src/integration/docs/caliptra_reg_html/content/011dc1672289d8fcebef76d827b3ed5944ae3740.html
This file was deleted.
Oops, something went wrong.
158 changes: 0 additions & 158 deletions
158
src/integration/docs/caliptra_reg_html/content/013fc3194ae8e4bcbfb91e9aebbd13943c939923.html
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.