Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
docs/** linguist-generated=true
src/spin_sdk/wit/** linguist-generated=true
src/componentize_py_* linguist-generated=true
src/componentize_py_*/** linguist-generated=true
40 changes: 40 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Build and Deploy Docs

on:
push:
branches: [main]
tags: ['v*']

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6

- name: Parse version
id: version
run: |
if [[ "${{ github.ref_type }}" == "tag" ]]; then
# Parse the major version
TAG="${{ github.ref_name }}"
echo "folder=${TAG%%.*}" >> $GITHUB_OUTPUT
else
# Default for pushes to main
echo "folder=canary" >> $GITHUB_OUTPUT
fi
- name: Generate Documentation
run: |
pip install pdoc3
./scripts/generate_docs.py ${{ steps.version.outputs.folder }}
- name: Deploy to versioned folder
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs
target-folder: docs
clean: false
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ __pycache__
src/spin_sdk.egg-info
dist
venv/
docs
8 changes: 1 addition & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,7 @@ bash regenerate_bindings.sh

### Updating docs

Any time you regenerate the bindings or edit files by hand, you'll want to
regenerate the HTML docs to match. First, install `pdoc` using `pip install
pdoc3`. Then, update the docs using:

```bash
./scripts/generate_docs.py
```
Docs are [updated automatically](.github/workflows/docs.yml) on merges to main and tag pushes.

### Building the distribution

Expand Down
612 changes: 0 additions & 612 deletions docs/http/index.html

This file was deleted.

1,899 changes: 0 additions & 1,899 deletions docs/http/poll_loop.html

This file was deleted.

114 changes: 0 additions & 114 deletions docs/index.html

This file was deleted.

Loading
Loading