Merge branch 'split-api-docs' into add-examples-express-split

Author: gadenbuie

.github/py-shiny/setup/action.yaml

@@ -25,6 +25,7 @@ runs:
         shell: bash
         run: |
           pip install https://github.com/rstudio/py-htmltools/tarball/main
+          pip install https://github.com/posit-dev/py-shinylive/tarball/main
           make install-deps
 
       - name: Install

.github/workflows/build-docs.yaml

@@ -34,7 +34,7 @@ jobs:
         run: |
           cd docs
           make ../venv
-          . ../venv/bin/activate && pip install https://github.com/rstudio/py-htmltools/tarball/main
+          . ../venv/bin/activate && pip install https://github.com/posit-dev/py-htmltools/tarball/main https://github.com/posit-dev/py-shinylive/tarball/main
           make deps
 
       - name: Run quartodoc

CHANGELOG.md

@@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
-## [UNRELEASED]
+## [0.7.0] - 2024-01-25
 
 ### Breaking Changes
 

docs/.gitignore

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

docs/Makefile

@@ -46,13 +46,23 @@ deps: $(PYBIN)  ## Install build dependencies
 	$(PYBIN)/pip install pip --upgrade
 	$(PYBIN)/pip install -e ..[doc]
 
-quartodoc: $(PYBIN) ## Build qmd files for API docs
+
+# `quartodoc interlinks` creates links in `_inv`
+quartodoc_impl: $(PYBIN) ## Build qmd files for API docs
 	$(eval export SHINY_ADD_EXAMPLES=true)
 	$(eval export IN_QUARTODOC=true)
 	. $(PYBIN)/activate \
 	  && quartodoc interlinks \
 	  && SHINY_MODE="core" quartodoc build --config _quartodoc-core.yml --verbose \
-	  && SHINY_MODE="express" quartodoc build --config _quartodoc-express.yml --verbose
+	  && mv objects.json _objects_core.json \
+	  && SHINY_MODE="express" quartodoc build --config _quartodoc-express.yml --verbose \
+	  && mv objects.json _objects_express.json
+
+quartodoc_post: $(PYBIN)  ## Post-process qmd files for API docs
+	. $(PYBIN)/activate \
+	  && python _combine_objects_json.py
+
+quartodoc: quartodoc_impl quartodoc_post
 
 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("\nCombinging 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")

setup.cfg

@@ -102,7 +102,7 @@ doc =
     jupyter
     jupyter_client < 8.0.0
     tabulate
-    shinylive @ git+https://github.com/posit-dev/py-shinylive.git
+    shinylive
     pydantic==1.10
     quartodoc==0.7.2
     griffe==0.33.0

shiny/__init__.py

@@ -1,6 +1,6 @@
 """A package for building reactive web applications."""
 
-__version__ = "0.6.1.9007"
+__version__ = "0.7.0"
 
 from ._shinyenv import is_pyodide as _is_pyodide