PyRTL's GitHub Pages Webpage

PyRTL's GitHub Pages webpage is at https://ucsbarchlab.github.io/PyRTL/ .

The sources for this webpage are in this www directory. The page is built with Sphinx, and written in reStructuredText. The main Sphinx configuration file is www/conf.py, and source for the main page is www/index.rst

Follow the instructions on this page to build a local copy of PyRTL's webpage. This is useful for verifying that PyRTL's webpage still renders correctly after making a local change.

There is additional PyRTL documentation in Read the Docs, see docs/README.md.

Running Sphinx

Run Sphinx with the provided justfile, from the repository's root directory:

# Run Sphinx to build PyRTL's webpage.
$ uv run just www

This builds a local copy of PyRTL's webpage in www/_build/html. www/_build/html/index.html is the home page.

Running JupyterLite Examples

The generated page in www/_build/html/index.html can be viewed in any web browser, but the JupyterLite examples won't work unless you run a web server:

$ cd www/_build/html/
$ uv run python3 -m http.server

Then open the URL displayed in your terminal.

GitHub Actions Workflow

When a commit is pushed that changes www/, the pages-deploy workflow automatically runs Sphinx to regenerate the webpage and deploy it to GitHub Pages.