Create two different api doc folders, one for Core and one for Express

docs/.gitignore

@@ -5,3 +5,5 @@ _sidebar.yml
 /.quarto/
 objects.json
 site_libs/
+_objects_core.json
+_objects_express.json

docs/Makefile

@@ -46,12 +46,39 @@ deps: $(PYBIN)  ## Install build dependencies
 	$(PYBIN)/pip install pip --upgrade
 	$(PYBIN)/pip install -e ..[doc]
 
-quartodoc: $(PYBIN) ## Build qmd files for API docs
+quartodoc: quartodoc_build_core quartodoc_build_express quartodoc_post ## Build quartodocs for express and core
+
+## Build interlinks for API docs
+quartodoc_interlinks: $(PYBIN)
+	. $(PYBIN)/activate \
+	  && quartodoc interlinks
+
+## Build core API docs
+quartodoc_build_core: $(PYBIN) quartodoc_interlinks
 	$(eval export SHINY_ADD_EXAMPLES=true)
 	$(eval export IN_QUARTODOC=true)
+	$(eval export SHINY_MODE=core)
+	. $(PYBIN)/activate \
+	  && echo "::group::quartodoc build core docs" \
+	  && quartodoc build --config _quartodoc-core.yml --verbose \
+	  && mv objects.json _objects_core.json \
+	  && echo "::endgroup::"
+
+## Build express API docs
+quartodoc_build_express: $(PYBIN) quartodoc_interlinks
+	$(eval export SHINY_ADD_EXAMPLES=true)
+	$(eval export IN_QUARTODOC=true)
+	$(eval export SHINY_MODE=express)
+	. $(PYBIN)/activate \
+	  && echo "::group::quartodoc build express docs" \
+	  && quartodoc build --config _quartodoc-express.yml --verbose \
+	  && mv objects.json _objects_express.json \
+	  && echo "::endgroup::"
+
+## Clean up after quartodoc build
+quartodoc_post: $(PYBIN)
 	. $(PYBIN)/activate \
-	  && quartodoc interlinks \
-	  && quartodoc build --config _quartodoc.yml --verbose
+	  && python _combine_objects_json.py
 
 site:  ## Build website
 	. $(PYBIN)/activate \

docs/_combine_objects_json.py

@@ -0,0 +1,64 @@
+import json
+from dataclasses import asdict, dataclass
+from typing import Literal, TypedDict
+
+
+@dataclass
+class QuartodocObject:
+    project: str
+    version: str
+    count: int
+    items: list["QuartodocObjectItem"]
+
+
+@dataclass
+class QuartodocObjectItem:
+    name: str
+    domain: str
+
+    # function: "shiny.ui.page_sidebar"
+    # class: "shiny.render.renderer._renderer.Renderer"
+    # attribute: "shiny.render.renderer._renderer.Renderer.output_id"
+    role: Literal["function", "class", "attribute", "module"]
+    priority: str
+    uri: str
+    dispname: str
+
+
+def read_objects_file(path: str) -> QuartodocObject:
+    with open(path) as file:
+        content = json.load(file)
+    items = [QuartodocObjectItem(**item) for item in content.pop("items")]
+    return QuartodocObject(**content, items=items)
+
+
+def write_objects_file(objects: QuartodocObject, path: str) -> None:
+    with open(path, "w") as file:
+        json.dump(objects, file, indent=4, default=lambda dc: dc.__dict__)
+
+
+print("\nCombining objects json files...")
+objects_core = read_objects_file("_objects_core.json")
+objects_express = read_objects_file("_objects_express.json")
+
+items_map: dict[str, QuartodocObjectItem] = {}
+
+for item in [*objects_core.items, *objects_express.items]:
+    if item.name in items_map:
+        continue
+    items_map[item.name] = item
+
+objects_ret = QuartodocObject(
+    project="shiny",
+    version="1",
+    count=len(items_map.values()),
+    items=[*items_map.values()],
+)
+
+
+print("Core:", objects_core.count)
+print("Express:", objects_express.count)
+print("Combined:", objects_ret.count)
+
+# Save combined objects file info
+write_objects_file(objects_ret, "objects.json")

docs/_quarto.yml

@@ -18,8 +18,10 @@ website:
     pinned: true
     search: true
     left:
-      - text: "API"
-        file: api/index.qmd
+      - text: "Express API"
+        file: api/express/index.qmd
+      - text: "Core API"
+        file: api/core/index.qmd
     right:
       - icon: github
         href: https://github.com/posit-dev/py-shiny

docs/_quartodoc.yml → docs/_quartodoc-core.yml

@@ -1,10 +1,10 @@
 quartodoc:
   style: pkgdown
-  dir: api
+  dir: api/core
   out_index: index.qmd
   package: shiny
   rewrite_all_pages: false
-  sidebar: api/_sidebar.yml
+  sidebar: api/core/_sidebar.yml
   dynamic: true
   renderer:
     style: _renderer.py
@@ -374,6 +374,7 @@ quartodoc:
         - ui.panel_main
         - ui.panel_sidebar
         - ui.nav
+        - render.transformer.output_transformer
         - render.transformer.resolve_value_fn
     - title: Experimental
       desc: "These methods are under consideration and are considered unstable. However, if there is a method you are excited about, please let us know!"

docs/_quartodoc-express.yml

@@ -0,0 +1,177 @@
+quartodoc:
+  style: pkgdown
+  dir: api/express
+  out_index: index.qmd
+  package: shiny
+  rewrite_all_pages: false
+  sidebar: api/express/_sidebar.yml
+  dynamic: true
+  renderer:
+    style: _renderer.py
+    show_signature_annotations: false
+  sections:
+    - title: Input components
+      desc: Gather user input.
+      contents:
+        - express.ui.input_select
+        - express.ui.input_selectize
+        - express.ui.input_slider
+        - express.ui.input_date
+        - express.ui.input_date_range
+        - express.ui.input_checkbox
+        - express.ui.input_checkbox_group
+        - express.ui.input_switch
+        - express.ui.input_radio_buttons
+        - express.ui.input_numeric
+        - express.ui.input_text
+        - express.ui.input_text_area
+        - express.ui.input_password
+        - express.ui.input_action_button
+        - express.ui.input_action_link
+    - title: Output components
+      desc: Reactively render output.
+      contents:
+        - express.render.plot
+        - express.render.table
+        - express.render.DataTable
+        - express.render.data_frame
+        - express.render.DataGrid
+        - express.render.text
+        - express.render.ui
+        - express.render.download
+        - express.render.image
+        - express.render.express
+    - title: Layouts and other UI tools
+      desc: Tools for creating, arranging, and styling UI components.
+      contents:
+        - express.ui.page_opts
+        - express.ui.sidebar
+        - express.ui.layout_columns
+        - express.ui.layout_column_wrap
+        - express.ui.card
+        - express.ui.card_header
+        - express.ui.card_footer
+        - express.ui.value_box
+        - express.ui.value_box_theme
+        - express.ui.popover
+        - express.ui.tooltip
+        - express.ui.accordion
+        - express.ui.accordion_panel
+        - express.ui.layout_sidebar
+    - title: Navigate multiple panels
+      desc: Create a set of panels that can be navigated between.
+      contents:
+        - express.ui.nav_panel
+        - express.ui.navset_card_underline
+        - express.ui.navset_card_tab
+        - express.ui.navset_card_pill
+        - express.ui.nav_spacer
+        - express.ui.nav_menu
+        - express.ui.nav_control
+        - express.ui.navset_bar
+        - express.ui.navset_tab
+        - express.ui.navset_pill
+        - express.ui.navset_underline
+        - express.ui.navset_pill_list
+        - express.ui.navset_hidden
+    - title: Reactive programming
+      desc: Create reactive functions and dependencies.
+      contents:
+        - reactive.calc
+        - reactive.effect
+        - reactive.value
+        - reactive.event
+        - reactive.isolate
+        - reactive.invalidate_later
+        - reactive.flush
+        - reactive.poll
+        - reactive.file_reader
+        - reactive.lock
+        - req
+    - title: Reusable Express code
+      desc: Create reusable Express code.
+      contents:
+        - express.ui.hold
+        - express.expressify
+    - title: Update inputs
+      desc: Programmatically update input values.
+      contents:
+        - name: express.ui.update_select
+          dynamic: true
+        - name: express.ui.update_selectize
+          dynamic: true
+        - name: express.ui.update_slider
+          dynamic: true
+        - ui.update_date
+        - name: express.ui.update_date_range
+          dynamic: true
+        - name: express.ui.update_checkbox
+          dynamic: true
+        - name: express.ui.update_checkbox_group
+          dynamic: true
+        - name: express.ui.update_switch
+          dynamic: true
+        - name: express.ui.update_radio_buttons
+          dynamic: true
+        - name: express.ui.update_numeric
+          dynamic: true
+        - ui.update_text
+        - name: express.ui.update_text_area
+          dynamic: "shiny.ui.update_text"
+        - name: express.ui.update_navs
+          dynamic: true
+    - title: Update UI Layouts
+      desc: ""
+      contents:
+        - express.ui.update_sidebar
+        - express.ui.update_tooltip
+        - express.ui.update_popover
+        - express.ui.update_accordion
+        - express.ui.update_accordion_panel
+        - express.ui.insert_accordion_panel
+        - express.ui.remove_accordion_panel
+    - title: Display messages
+      desc: Display messages to the user.
+      contents:
+        - express.ui.help_text
+        - express.ui.notification_show
+        - express.ui.notification_remove
+        - express.ui.modal
+        - express.ui.modal_show
+        - express.ui.modal_remove
+        - express.ui.modal_button
+        - express.ui.Progress          # uses class.rst
+    - title: UI panels
+      desc: Visually group together a section of UI components.
+      contents:
+        - express.ui.panel_absolute
+        - express.ui.panel_fixed
+        - express.ui.panel_title
+        - express.ui.panel_well
+    - title: Dynamic UI
+      desc: Dynamically show/hide UI elements.
+      contents:
+        - express.ui.panel_conditional
+        - express.ui.insert_ui
+        - express.ui.remove_ui
+    - title: UI as HTML
+      desc: Tools for creating HTML/CSS/JS
+      contents:
+        - express.ui.markdown
+        - express.ui.include_css
+        - express.ui.include_js
+        - express.ui.HTML       # uses justattributes.rst template
+        - name: express.ui.tags       # uses tags.rst template
+          children: embedded
+        - express.ui.TagList    # uses class.rst template
+        # TODO: should these be included?
+        # - express.ui.fill.as_fillable_container
+        # - express.ui.fill.as_fill_item
+        # - express.ui.fill.remove_all_fill
+        # - express.ui.css.as_css_unit
+        # - express.ui.css.as_css_padding
+    - title: Express developer tooling
+      desc:
+      contents:
+        - express.is_express_app
+        - express.wrap_express_app