From 1bf6cc0e72aa02e64f5965f22c96295411172876 Mon Sep 17 00:00:00 2001 From: Peter W <34256109+pww217@users.noreply.github.com> Date: Thu, 26 May 2022 16:56:54 -0500 Subject: [PATCH] Fix examples Ci, Makefile, some doc references (#469) * fix examples ci, makefile, and update docs * getting started reference --- .github/workflows/sync-examples.yml | 6 +++--- README.md | 4 ++-- docs/tutorials/getting-started.md | 2 +- pyscriptjs/Makefile | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/sync-examples.yml b/.github/workflows/sync-examples.yml index 07a8c9a2..c67c8c5c 100644 --- a/.github/workflows/sync-examples.yml +++ b/.github/workflows/sync-examples.yml @@ -1,11 +1,11 @@ name: '[CI] Sync Examples' on: - push: # Only run on merges into main that modify files under pyscriptjs/examples/ + push: # Only run on merges into main that modify files under examples/ branches: - main paths: - - pyscriptjs/examples/** + - examples/** - .github/workflows/sync-examples.yml # Test that workflow works when changed jobs: @@ -16,7 +16,7 @@ jobs: id-token: write defaults: run: - working-directory: pyscriptjs/examples + working-directory: examples steps: diff --git a/README.md b/README.md index f8366fce..15135cf3 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ PyScript is a Pythonic alternative to Scratch, JSFiddle, and other "easy to use" To get started see the [getting started tutorial](docs/tutorials/getting-started.md). -For examples see [the pyscript folder](pyscriptjs). +For examples see [here](examples). ### Longer Version PyScript is a meta project that aims to combine multiple open technologies into a framework that allows users to create sophisticated browser applications with Python. It integrates seamlessly with the way the DOM works in the browser and allows users to add Python logic in a way that feels natural both to web and Python developers. @@ -24,7 +24,7 @@ You can then use PyScript components in your html page. PyScript currently imple * ``: can be used to define python code that is executable within the web page. The element itself is not rendered to the page and is only used to add logic * ``: creates a REPL component that is rendered to the page as a code editor and allows users to write executable code -Check out the [pyscriptjs/examples](pyscriptjs/examples) folder for more examples on how to use it, all you need to do is open them in Chrome. +Check out the [the examples directory](examples) folder for more examples on how to use it, all you need to do is open them in Chrome. ## How to Contribute diff --git a/docs/tutorials/getting-started.md b/docs/tutorials/getting-started.md index 03289c67..443ab58e 100644 --- a/docs/tutorials/getting-started.md +++ b/docs/tutorials/getting-started.md @@ -115,7 +115,7 @@ In addition to the [Python Standard Library](https://docs.python.org/3/library/) the `pyscript` module, many 3rd-party OSS packages will work out-of-the-box with PyScript. In order to use them, you will need to declare the dependencies using the `` tag in the -HTML head. You can also link to `.whl` files directly on disk like in our [toga example](https://github.com/pyscript/pyscript/blob/main/pyscriptjs/examples/toga/freedom.html). +HTML head. You can also link to `.whl` files directly on disk like in our [toga example](https://github.com/pyscript/pyscript/blob/main/examples/toga/freedom.html). ``` diff --git a/pyscriptjs/Makefile b/pyscriptjs/Makefile index 13663c44..fa794c2a 100644 --- a/pyscriptjs/Makefile +++ b/pyscriptjs/Makefile @@ -3,7 +3,7 @@ git_hash ?= $(shell git log -1 --pretty=format:%h) base_dir ?= $(shell git rev-parse --show-toplevel) src_dir ?= $(base_dir)/src -examples ?= $(base_dir)/examples +examples ?= ../$(base_dir)/examples app_dir ?= $(shell git rev-parse --show-prefix) CONDA_EXE := conda