Skip to content

Commit

Permalink
start on docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tomgrek committed Jan 21, 2024
1 parent 91de07c commit 53ade22
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/pages-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Deploy Sphinx documentation to Pages

on:
push:
branches: [main]

jobs:
pages:
runs-on: ubuntu-20.04
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
pages: write
id-token: write
steps:
- id: deployment
uses: sphinx-notes/pages@v3
4 changes: 4 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
PyPhonic
========

A Python server for a VST plugin client.
2 changes: 2 additions & 0 deletions src/pyphonic/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
# midi is working both VST side and network side.

# TODO do the flippin kubernetes thing
# widgets for oscilloscope, display midi notes output
# sort out why user must return a bytearray. wrap this!
# Destruction test!
# Some kind of authentication on top of the magic packet, maybe just on initial connect
# collection of primitives, e.g. return (sinewave(72).pan(-0.8) + sawtooth(72, drift=0.1).pan(0.7)).delay("3/16", wet=0.6).filter("hp12", cutoff=300)...
Expand Down

0 comments on commit 53ade22

Please sign in to comment.