diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..5387fde --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,29 @@ +name: GitHub Pages + +on: + push: + tags: ["v*.*.*"] + workflow_dispatch: + +jobs: + deploy-docs: + runs-on: ubuntu-22.04 + permissions: + contents: write + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + steps: + - uses: actions/checkout@v3 + + - name: Add Source to Docs + run: | + mkdir docs/viv -p + cp ./src/viv/viv.py docs/viv/viv.py + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.ref == 'refs/heads/main' }} + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + # publish_dir: ./site + publish_dir: ./docs diff --git a/docs/demo.gif b/docs/demo.gif deleted file mode 100644 index 8c04160..0000000 Binary files a/docs/demo.gif and /dev/null differ diff --git a/docs/demo.py b/docs/demo.py deleted file mode 100644 index 0878927..0000000 --- a/docs/demo.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python3 - -__import__("viv").use("pyfiglet==0.8.post1") # noqa - -from pyfiglet import Figlet - -if __name__ == "__main__": - f = Figlet(font="slant") - figtxt = f.renderText("viv").splitlines() - figtxt[-2] += " isn't venv!" - print("\n".join(figtxt)) diff --git a/docs/demo.tape b/docs/demo.tape deleted file mode 100644 index 5ea92ec..0000000 --- a/docs/demo.tape +++ /dev/null @@ -1,23 +0,0 @@ -Set Height 750 -Set Width 1500 -Set Theme "Catppuccin Mocha" -Output ./demo.gif - -Type "viv list" -Enter -Sleep 2s -Type "python ../examples/cli.py --help" -Enter -Sleep 10s -Type "viv list" -Enter -Sleep 3s -Type "viv info 841" -Enter -Sleep 3s -Type "python ../examples/cli.py hello 'prospective viv user!'" -Enter -Sleep 2s -Type "python ../examples/cli.py goodbye 'prospective viv user!'" -Enter -Sleep 2s diff --git a/docs/freeze.tape b/docs/freeze.tape deleted file mode 100644 index 38eaa7e..0000000 --- a/docs/freeze.tape +++ /dev/null @@ -1,23 +0,0 @@ -Set Height 750 -Set Width 1500 -Set Theme "Catppuccin Mocha" -Output ./freeze.gif - -Type "viv freeze --help" -Enter -Sleep 2s -Type "viv list" -Enter -Sleep 2s -Type "viv freeze requests bs4" -Enter -Sleep 7s -Type "viv list" -Enter -Sleep 3s -Type "viv freeze requests bs4 --keep --path relative" -Enter -Sleep 7s -Type "viv list" -Enter -Sleep 5s diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..b4ab837 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/list-info-remove.tape b/docs/list-info-remove.tape deleted file mode 100644 index 2d76998..0000000 --- a/docs/list-info-remove.tape +++ /dev/null @@ -1,30 +0,0 @@ -Set Height 750 -Set Width 1500 -Set Theme "Catppuccin Mocha" -Output ./list-info-remove.gif - -Type "cat demo.py" -Enter -Sleep 500ms -Type "python demo.py" -Enter -Sleep 3s -Type "viv list -h" -Enter -Sleep 500ms -Type "viv list -q" -Enter -Sleep 1s -Type "viv info -h" -Enter -Sleep 500ms -Type "viv info " -Sleep 1s -Type "f8" -Enter -Sleep 1s -Type "viv remove -h" -Enter -Type "viv rm f8" -Enter -Sleep 2s diff --git a/docs/usage.md b/docs/usage.md deleted file mode 100644 index fd16c44..0000000 --- a/docs/usage.md +++ /dev/null @@ -1,18 +0,0 @@ -# Usage - -*NOTE*: these demo gif's are a work in progress. If you'd like to see them you can run `vhs` locally with `make docs`. - -
-# Demo - -demo - -# Freeze - -demo - -# List | Info | Remove - -demo - -