Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split API docs into separate Express and Core #78

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
15 changes: 11 additions & 4 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ project:
- docs
- development
- gallery
- api
- api/express
- api/core
resources:
- /pypi/**
- /robots.txt
- /_redirects
- objects.json
- "*.png"
- "*.gif"
Expand All @@ -28,7 +30,8 @@ project:
- scripts/post-render.py

metadata-files:
- api/_sidebar.yml
- api/express/_sidebar.yml
- api/core/_sidebar.yml

filters:
- shinylive
Expand Down Expand Up @@ -84,8 +87,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
Expand Down
2 changes: 2 additions & 0 deletions _redirects
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/api/express/* /api/express/:splat
/api/* /api/core/:splat
9 changes: 9 additions & 0 deletions api/core/index.qmd
Original file line number Diff line number Diff line change
@@ -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 >}}
9 changes: 9 additions & 0 deletions api/express/index.qmd
Original file line number Diff line number Diff line change
@@ -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 >}}