Skip to content

Use examples' README front matter to generate the demo website #2429

@abey79

Description

@abey79

Currently, a list of of examples and related metadata is hardcoded in script/build_demo_app.py, but this is somewhat redundant with the examples' README front matter. I suggest improving this script such that:

  • it pulls all example whose front matter includes demo: true
  • it pulls the metadata from the front matter

Examples' front matter will need to include:

  • demo: true (if the example is to be included as demo)
  • description: ... (needed anyways for the example landing page)
  • demo_build_args: [] for optional build argument when generating the demo site

Some mechanism should also be devised to generate/avoid script/requirements-web-demo.txt.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestexamplesIssues relating to the Rerun examples🕸️ webregarding running the viewer in a browser🧑‍💻 dev experiencedeveloper experience (excluding CI)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions