AirWire

AirWire is a high resolution signal RX/TX over the air. Signal with 16-bit resolution in/out at min 1 kHz. CAN 2.0 RX/TX at all speeds.

Upstream reference: seipv/AirWire

Documentation site (Sphinx + GitHub Pages)

What you have

Sphinx turns plain text (mostly reStructuredText, .rst) into a static HTML site. GitHub Pages hosts that HTML; GitHub Actions builds it on every push to main and publishes it.

The workflow lives in .github/workflows/sphinx-pages.yml. It installs dependencies from docs/requirements.txt, runs sphinx-build, adds a .nojekyll file (so GitHub Pages does not ignore Sphinx folders like _static), then uploads the built site to Pages.

Repository layout

Path	Role
docs/source/conf.py	Sphinx settings (title, theme, extensions).
docs/source/index.rst	Home page content and table of contents.
docs/requirements.txt	Python packages CI uses to build.
.github/workflows/sphinx-pages.yml	Builds HTML and deploys to Pages.
.gitignore	Ignores docs/_build/ (build output) and local venv.

Edit and preview locally

Install Python 3 first. Then pick the section for your OS, run the commands from the repository root.

macOS / Linux (bash, zsh)

python3 -m venv .venv-docs
source .venv-docs/bin/activate
pip install -r docs/requirements.txt
sphinx-build -b html docs/source docs/_build/html

Serve the build:

python3 -m http.server --directory docs/_build/html

Windows 11 (PowerShell)

When installing Python from python.org, tick Add python.exe to PATH so py and python work in any new terminal.

py -m venv .venv-docs
.\.venv-docs\Scripts\Activate.ps1
pip install -r docs\requirements.txt
sphinx-build -b html docs\source docs\_build\html

If Activate.ps1 is blocked with “running scripts is disabled on this system,” allow local scripts once for your user, then activate again:

Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned

Serve the build (PowerShell does not have a --directory shortcut limitation; this works as-is):

py -m http.server --directory docs\_build\html

Windows 11 (Command Prompt, cmd.exe)

py -m venv .venv-docs
.venv-docs\Scripts\activate.bat
pip install -r docs\requirements.txt
sphinx-build -b html docs\source docs\_build\html

py -m http.server --directory docs\_build\html

View the result

Either open docs/_build/html/index.html directly in a browser, or after starting the server above, visit http://localhost:8000/.

Edit docs/source/index.rst for the home page. Add more .rst files under docs/source/, then list them under the .. toctree:: block in index.rst.

GitHub Pages (one-time setup)

1. Push this repository to GitHub.
2. In the repo: Settings → Pages.
3. Under Build and deployment, set Source to GitHub Actions (not “Deploy from a branch”).
4. The first push to **main** runs Build & Deploy Sphinx to GitHub Pages. When the deploy job finishes, the workflow summary shows the live URL (often https://<username>.github.io/AirWire/ for a project site, depending on account and repo name).

If the workflow fails

• Wrong branch: In sphinx-pages.yml, the on.push.branches list must include your default branch (main vs master).
• Pages permission: For a private organization repository, Pages may need to be allowed in organization policy.
• First deploy: Approve the github-pages environment if GitHub prompts for environment approval.

Typical workflow

1. Build locally with the commands above until the docs look right.
2. Commit and push to main.
3. Check the Actions tab for a green run and open the URL from the deploy job summary.