From 4d02da84f65f06ceb1936d524988f339e74a4a41 Mon Sep 17 00:00:00 2001 From: Carson Date: Thu, 25 Jan 2024 14:23:41 -0600 Subject: [PATCH 1/2] Generate a reference for both Core and Express --- Makefile | 3 ++- _quarto.yml | 14 ++++++++++---- api/core/index.qmd | 9 +++++++++ api/express/index.qmd | 9 +++++++++ py-shiny | 2 +- 5 files changed, 31 insertions(+), 6 deletions(-) create mode 100644 api/core/index.qmd create mode 100644 api/express/index.qmd diff --git a/Makefile b/Makefile index ac8e37a4..e0fc2f91 100644 --- a/Makefile +++ b/Makefile @@ -76,7 +76,8 @@ quartodoc: rsync -av --exclude="index.qmd" py-shiny/docs/api/ ./api cp -R py-shiny/docs/_inv py-shiny/docs/objects.json ./ # Copy over index.qmd, but rename it to _api_index.qmd - cp py-shiny/docs/api/index.qmd ./api/_api_index.qmd + cp py-shiny/docs/api/express/index.qmd ./api/express/_api_index.qmd + cp py-shiny/docs/api/core/index.qmd ./api/core/_api_index.qmd ## Build website site: diff --git a/_quarto.yml b/_quarto.yml index fc8fea7f..c7b163c5 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -15,7 +15,8 @@ project: - docs - development - gallery - - api + - api/express + - api/core resources: - /pypi/** - /robots.txt @@ -28,7 +29,8 @@ project: - scripts/post-render.py metadata-files: - - api/_sidebar.yml + - api/express/_sidebar.yml + - api/core/_sidebar.yml filters: - shinylive @@ -84,8 +86,12 @@ website: href: https://shinylive.io/py/examples/ target: _blank - text: "Reference" - href: api/index.qmd - right: + menu: + - text: "Shiny Express" + href: api/express/index.qmd + - text: "Shiny Core" + href: api/core/index.qmd + tools: - icon: discord href: https://discord.gg/yMGCamUMnS aria-label: Shiny Discord diff --git a/api/core/index.qmd b/api/core/index.qmd new file mode 100644 index 00000000..d7b9a2fd --- /dev/null +++ b/api/core/index.qmd @@ -0,0 +1,9 @@ +# Shiny Core API + +This page outlines Shiny _Core_'s API reference. + +[Compared to Shiny Express](/docs/express-introduction.qmd), Shiny Core is more structured and verbose, but also more flexible and powerful. + +Newcomers may want to start with [Shiny Express](../express/index.qmd) Shiny Core API. + +{{< include _api_index.qmd >}} diff --git a/api/express/index.qmd b/api/express/index.qmd new file mode 100644 index 00000000..81c6759c --- /dev/null +++ b/api/express/index.qmd @@ -0,0 +1,9 @@ +# Shiny Express API + +This page outlines Shiny _Express_'s API reference. + +[Compared to Shiny Core](/docs/express-introduction.qmd), Shiny Express is a simpler way to learn and create basic apps, but it is less flexible and powerful. + +For an introduction to Shiny, see the [Quick Start tutorial](/docs/quick-start.qmd). + +{{< include _api_index.qmd >}} diff --git a/py-shiny b/py-shiny index 9ad2ab12..a16fbd85 160000 --- a/py-shiny +++ b/py-shiny @@ -1 +1 @@ -Subproject commit 9ad2ab12ae0054ac745efed78da5fceb1e09fc43 +Subproject commit a16fbd857a4115675c9e08c3dd16851eb415d3b2 From 9d634da49cdccf7598a5396ea62636b480ec071d Mon Sep 17 00:00:00 2001 From: Carson Date: Thu, 25 Jan 2024 17:51:31 -0600 Subject: [PATCH 2/2] Add _redirects for old API links --- _quarto.yml | 1 + _redirects | 2 ++ 2 files changed, 3 insertions(+) create mode 100644 _redirects diff --git a/_quarto.yml b/_quarto.yml index c7b163c5..0f62f54a 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -20,6 +20,7 @@ project: resources: - /pypi/** - /robots.txt + - /_redirects - objects.json - "*.png" - "*.gif" diff --git a/_redirects b/_redirects new file mode 100644 index 00000000..4b83c812 --- /dev/null +++ b/_redirects @@ -0,0 +1,2 @@ +/api/express/* /api/express/:splat +/api/* /api/core/:splat