Deploy GitHub pages from GitHub actions with Sphinx - #489
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## development #489 +/- ##
===========================================
Coverage 93.8% 93.8%
===========================================
Files 30 30
Lines 7172 7172
===========================================
Hits 6722 6722
Misses 450 450 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
fdxmw
force-pushed
the
pages
branch
6 times, most recently
from
June 30, 2026 21:12
f57a1ed to
02cd219
Compare
Contributor
Author
|
I have follow-up changes to this PR that add Jupyter Lite "try this example in your browser" buttons to the webpage. The preview at https://fdxmw.github.io/PyRTL/ currently includes these follow-up changes. The source for these changes are in |
… actions with Sphinx. This replaces the old `gh-pages` branch workflow, and generates the HTML with Sphinx so we don't have to edit HTML tags. We can also update the code, documentation, and webpage in the same commit. GitHub Pages' `index.html` is now generated from `www/index.rst`. Sphinx automatically runs from GitHub actions when changes are pushed to `www/`. Also: * Added simulation scripts (create `Simulation`, `step`, `render_trace`) to all code samples. * Move the code samples to separate `.py` files in `www/examples` so `ruff` can auto-format them and check them for lint, and `test_examples.py` can test them. * Add screenshots for all `render_trace` outputs. Remove the GCD block graph. Increase resolution for all screenshots. Set screenshot width in `em`s so the text in screenshots is the same size as surrounding text. * Add many type hints and links to PyRTL documentation and examples. * Fix many typos. * Remove Sphinx version information and copyright from documentation footers. * Update READMEs, add instructions for updating screenshots. * Move "Gotchas" and "Related Projects" sections to documentation. * Reduce `example2.py`'s number of simulated cycles so the screenshot displays better on narrow screens.
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
1 participant
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 PR significantly changes PyRTL's GitHub Pages workflow. This will also change the appearance of http://ucsbarchlab.github.io/PyRTL, a preview is available at https://fdxmw.github.io/PyRTL/
This replaces the old
gh-pagesbranch workflow, and generates the HTML with Sphinx so we don't have to manually edit HTML. GitHub Pages'index.htmlis now generated fromwww/index.rst, which is much easier to edit. Sphinx automatically runs from GitHub actions when changes are pushed towww/.Also:
Added simulation scripts to all GitHub pages code samples. Add tests for these scripts.
Add screenshots for all
render_traceoutputs. Remove GCD block graph and improve formatting.Moved the larger code samples to external
.pyfiles inwww/examplessoruffcan auto-format them and check them for lint.Added many type hints.
Added many PyRTL documentation and example links.
Fixed many typos.
Upgraded some GitHub actions workflows.
Remove Sphinx version information and copyright from documentation footers.
Update READMEs.