Merge pull request #906 from thewtex/live-api-demo

docs: add Live API Demo to demo app headings

.gitignore

@@ -75,6 +75,7 @@ test/pipelines/input-output-json-pipeline/emscripten-build/
 test/pipelines/input-output-json-pipeline/wasi-build/
 test/pipelines/bindgen-interface-types-pipeline/python/
 test/pipelines/bindgen-interface-types-pipeline/wasi-build/
+test/pipelines/bindgen-interface-types-pipeline/python-web-demo
 
 cypress/screenshots/
 cypress/videos/

docs/conf.py

@@ -29,7 +29,7 @@
 
 autodoc2_packages = [
     {
-        "path": "../itkwasm",
+        "path": "../packages/core/python/itkwasm/itkwasm",
         "exclude_files": ["_to_numpy_array.py",],
     },
 ]

docs/development/hacking_itk_wasm.md

@@ -6,15 +6,15 @@ Thank you for contributing a pull request!
 
 We are glad you are here and appreciate your contribution. Please keep in mind our [community participation guidelines](https://github.com/InsightSoftwareConsortium/ITK/blob/main/CODE_OF_CONDUCT.md).
 
-### Build dependencies
+## Build dependencies
 
 - [Node.js / NPM](https://nodejs.org/en/download/)
 - [Docker](https://docs.docker.com/install/)
   * On Linux, make sure you can run [`docker` without `sudo`](https://askubuntu.com/questions/477551/how-can-i-use-docker-without-sudo).
   * On Windows, we recommend [WSL 2 with Docker enabled](https://docs.docker.com/desktop/windows/wsl/).
 - Bash
 
-### Building
+## Building
 
 To build itk-wasm itself:
 ```sh
@@ -33,7 +33,7 @@ npm i -g docsify
 docsify serve ./docs/
 ```
 
-Create a debug build (see also: [the debugging example](/cxx/tutorial/debugging.html)):
+Create a debug build (see also: [the debugging example](/cxx/tutorial/debugging)):
 
 ```sh
 # pull the latest debug Docker images
@@ -50,15 +50,15 @@ substitution for your Wasm module's source code.
 
 Example: `/ITKWebAssemblyInterface/` -> `/home/dingbat/src/itk-wasm/`
 
-### Add test data
+## Add test data
 
 To prevent Git repository bloat, we add testing data through [CMake content links](https://blog.kitware.com/cmake-externaldata-using-large-files-with-distributed-version-control/) of [Content Identifiers (CIDs)](https://proto.school/anatomy-of-a-cid). To add new test data,
 
 1. Upload the data and download its content link *.cid* file with the [CMake w3 ExternalData Upload Tool](https://cmake-w3-externaldata-upload.on.fleek.co/)
 2. Move the *.cid* file to *itk-wasm/test/Input/*
 3. Reference the content link with a `DATA{<path>}` call in *itk-wasm/test/CMakeLists.txt*.
 
-### Contributing
+## Contributing
 
 We use [semantic-release](https://github.com/semantic-release/semantic-release) for handling the change log and version. Therefore, we recommend using the following command line when creating a commit:
 

docs/introduction/packages.md

@@ -6,8 +6,8 @@ request](https://github.com/InsightSoftwareConsortium/itk-wasm/compare) to add i
 
 | <img width=100/> Repository | <img width=125/> Description <img width=125/> | <img width=200/> Links |
 |-----------------------------|:---------------------------------------------:|:----------------------:|
-| [@itk-wasm/compress-stringify][compress-stringify-repo] | <img src="../_static/packages/compress-stringify.png" width="128" /><br />  *Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.* | ![js][js-logo] ![ts][ts-logo] <br/>[💻 Demo][compress-stringify-demo-js] <br/>[🕮 Docs][compress-stringify-docs-js] <br/>[📦 Package][compress-stringify-package-js] <br/> <br/> ![py][py-logo] <br/>[💻 Demo][compress-stringify-demo-py] <br/>[🕮 Docs][compress-stringify-docs-py] <br/>[📦 Package][compress-stringify-package-py] |
-| [@itk-wasm/dicom][dicom-repo] | <img src="../_static/packages/dicom.png" width="128" /> <br /> *Read files and images related to DICOM file format.* | ![js][js-logo] ![ts][ts-logo] <br/>[💻 Demo][dicom-demo-js] <br/>[🕮 Docs][dicom-docs-js] <br/>[📦 Package][dicom-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][dicom-docs-py] <br/>[📦 Package][dicom-package-py] |
+| [@itk-wasm/compress-stringify][compress-stringify-repo] | [<img src="../_static/packages/compress-stringify.png" width="128" />][compress-stringify-demo-js]<br />  *Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][compress-stringify-demo-js] <br/>[🕮 Docs][compress-stringify-docs-js] <br/>[📦 Package][compress-stringify-package-js] <br/> <br/> ![py][py-logo] <br/>[👨‍💻 Demo][compress-stringify-demo-py] <br/>[🕮 Docs][compress-stringify-docs-py] <br/>[📦 Package][compress-stringify-package-py] |
+| [@itk-wasm/dicom][dicom-repo] | [<img src="../_static/packages/dicom.png" width="128" />][dicom-demo-js] <br /> *Read files and images related to DICOM file format.* | ![js][js-logo] ![ts][ts-logo] <br/>[👨‍💻 Demo][dicom-demo-js] <br/>[🕮 Docs][dicom-docs-js] <br/>[📦 Package][dicom-package-js] <br/> <br/> ![py][py-logo] <br/>[🕮 Docs][dicom-docs-py] <br/>[📦 Package][dicom-package-py] |
 
 [js-logo]: /_static/javascript-logo.svg
 [ts-logo]: /_static/typescript-logo.svg

packages/compress-stringify/python/itkwasm-compress-stringify/README.md

@@ -4,7 +4,7 @@
 
 Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.
 
-[💻 **Live API Demo** ✨](https://itk-compress-stringify-py-app.on.fleek.co/)
+[👨‍💻‍ **Live API Demo** ✨](https://itk-compress-stringify-py-app.on.fleek.co/)
 
 [🕮 **Documentation** 📚](https://itk-wasm-compress-stringify-python-docs.on.fleek.co/)
 

packages/compress-stringify/typescript/README.md

@@ -4,7 +4,7 @@
 
 > Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.
 
-[💻 **Live API Demo** ✨](https://itk-compress-stringify-app.on.fleek.co/ ':include :type=iframe width=100% height=800px')
+[👨‍💻 **Live API Demo** ✨](https://itk-compress-stringify-app.on.fleek.co/ ':include :type=iframe width=100% height=800px')
 
 [🕮 **Documentation** 📚](https://itk-compress-stringify-docs.on.fleek.co/)
 

packages/dicom/typescript/README.md

@@ -4,9 +4,9 @@
 
 > Read files and images related to DICOM file format.
 
-[Example](https://itk-wasm-dicom-app.on.fleek.co/ ':include :type=iframe width=100% height=800px')
+[💻 **Live API Demo** ✨](https://itk-wasm-dicom-app.on.fleek.co/ ':include :type=iframe width=100% height=800px')
 
-[Documentation](https://itk-wasm-dicom-docs.on.fleek.co/)
+[🕮 **Documentation** 📚](https://itk-wasm-dicom-docs.on.fleek.co/)
 
 ## Installation
 

src/bindgen/typescript/resources/demo-app/index.html

@@ -21,6 +21,7 @@
 
   <h2>@bindgenPackageName@</h2>
   <i>@bindgenPackageDescription@</i>
+  <h3>👨‍💻 Live API Demo ✨</h3>
   <br /><br />
 
   <sl-tab-group>