v0.7.0 (#44)

Author: gadenbuie

.github/workflows/quartodoc.yaml

@@ -6,6 +6,7 @@ on:
       tags:
         - 'v[0-9]+.[0-9]+.[0-9]+'         # build on version tags
         - '!v[0-9]+.[0-9]+.[0-9]+.[0-9]+' # but not if version involves a dev component
+        - '!v[0-9]+.[0-9]+.[0-9]+.dev'    # or a .dev suffix
       branches:
         - main
 
@@ -60,6 +61,8 @@ jobs:
           env_file = os.getenv("GITHUB_ENV")
           with open(env_file, "a") as github_env:
               github_env.write(f"DOCS_SUBDIR={subdir}")
+              if is_dev:
+                  github_env.write(f"\nDOCS_PROFILE=dev")
 
       # If event is a tag, set subdir to '<tag_name>'
       - name: "[tag] Set versioned DOCS_SUBDIR"
@@ -80,7 +83,7 @@ jobs:
           git config --local user.name "$GITHUB_ACTOR"
           git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com"
           git add -A
-          git commit -m "Build docs from ${GITHUB_REF}"
+          git commit -m "Build docs from ${GITHUB_REF}" || exit 0
 
           # Rebase to include any changes pushed while building docs
           git pull --rebase origin gh-pages

CHANGELOG.md

@@ -5,15 +5,15 @@ All notable changes to `shinyswatch` will be documented in this file.
 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] - YYYY-MM-DD
+## [0.7.0] - 2024-07-18
 
 ### Breaking changes
 
-* shinyswatch now uses the newly-introduced `shiny.ui.Theme()` class to define themes. As a result, `shinyswatch.theme.{name}` objects can no longer be added anywhere in the app's UI. Instead, pass a shinyswatch theme to the `theme` argument of any `shiny.ui.page_*()` functions (Shiny Core) or to `shiny.express.ui.page_opts()` (Shiny Express). (#39)
+* shinyswatch now requires shiny v1.0.0 or newer to use the newly-introduced `shiny.ui.Theme()` class to define themes. As a result, `shinyswatch.theme.{name}` objects can no longer be added anywhere in the app's UI. Instead, pass a shinyswatch theme to the `theme` argument of any `shiny.ui.page_*()` functions (Shiny Core) or to `shiny.express.ui.page_opts()` (Shiny Express). (#39)
 
 * The `default` argument of `theme_picker_ui()` is now deprecated. Instead, pass the initial theme to the `theme` argument of any `shiny.ui.page_*()` functions (Shiny Core) or to `shiny.express.ui.page_opts()` (Shiny Express). This change separates the initial theme selection from the placement of the theme picker input. (#39)
 
-* `shinyswatch.get_theme_deps()` was removed from the pacakge. If needed, use the `._html_dependency()` method of the theme object. (#39)
+* `shinyswatch.get_theme_deps()` was removed from the package. If needed, use the `._html_dependency()` method of the theme object. (#39)
 
 ### New features
 

Makefile

@@ -67,20 +67,28 @@ coverage: ## check code coverage quickly with the default Python
 # sites for the same repository, in particular to put the dev docs at `dev/`.
 DOCS_SUBDIR:=
 DOCS_OUTPUT_DIR:="_site/$(DOCS_SUBDIR)"
+DOCS_PROFILE:=
+
+SHINYSWATCH_VERSION := $(shell python3 -c "import shinyswatch; print(shinyswatch.__version__)")
 
 quarto-shinylive: ## Make sure quarto-shinylive is installed
 	cd docs && (test -f _extensions/quarto-ext/shinylive/shinylive.lua || quarto install extension --no-prompt quarto-ext/shinylive)
 quarto-interlinks: ## Make sure quartodocs's interlinks is installed
 	cd docs && (test -f _extensions/machow/interlinks/interlinks.lua || quarto install extension --no-prompt machow/quartodoc)
-docs-quartodoc: quarto-shinylive quarto-interlinks ## Build quartodoc
+quarto-line-highlight:
+	cd docs && (test -f _extensions/shafayetShafee/line-highlight/_extension.yml || quarto install extension --no-prompt shafayetShafee/line-highlight)
+docs-quartodoc: quarto-shinylive quarto-interlinks quarto-line-highlight ## Build quartodoc
 	cd docs && python -m quartodoc build --verbose
 	cd docs && python -m quartodoc interlinks
 docs-render: quarto-shinylive
-	cd docs && quarto render
+	export SHINYSWATCH_VERSION=$(SHINYSWATCH_VERSION) && \
+	cd docs && quarto render --profile ${DOCS_PROFILE}
 docs-render-ci: quarto-shinylive
-	cd docs && quarto render --no-clean --output-dir $(DOCS_OUTPUT_DIR)
+	export SHINYSWATCH_VERSION=$(SHINYSWATCH_VERSION) && \
+	cd docs && quarto render --no-clean --output-dir $(DOCS_OUTPUT_DIR) --profile ${DOCS_PROFILE}
 docs-watch: quarto-shinylive
-	cd docs && quarto preview
+	export SHINYSWATCH_VERSION=$(SHINYSWATCH_VERSION) && \
+	cd docs && quarto preview --profile ${DOCS_PROFILE}
 docs-ci: docs-quartodoc docs-render-ci ## Build quartodoc for CI
 docs-readme: README.md ## Build README.md from index.qmd
 	quarto render docs/index.qmd --output README.md --output-dir . --profile readme

docs/.gitignore

@@ -7,3 +7,4 @@
 /_sidebar.yml
 /site_libs/
 /index.html
+/changelog.md

docs/_quarto-dev.yml

@@ -0,0 +1,5 @@
+website:
+  announcement:
+    dismissable: false
+    content: |
+      This is the development version of shinyswatch. [Go to the stable version](https://posit-dev.github.io/py-shinyswatch).

docs/_quarto.yml

@@ -2,6 +2,8 @@ project:
   type: website
   resources:
     - objects.json
+  pre-render:
+    - cp ../CHANGELOG.md changelog.md
 
 metadata-files:
   - _sidebar.yml
@@ -68,12 +70,31 @@ quartodoc:
 
 website:
   title: shinyswatch
+  site-url: https://posit-dev.github.io/py-shinyswatch
+  repo-url: https://github.com/posit-dev/py-shinyswatch
   navbar:
+    foreground: white
+    background: primary
     left:
-      # - href: https://machow.github.io/quartodoc/
-      #   text: quartodoc home
+      - href: index.qmd
+        text: Get Started
       - file: reference/index.qmd
         text: "Reference"
-    right:
+      - text: "News"
+        menu:
+          - text: v0.7.0
+            href: https://shiny.posit.co/blog/posts/shinyswatch-0.7.0/
+          - text: "---"
+          - text: "Changelog"
+            href: changelog.md
+    tools:
       - icon: github
-        href: https://github.com/rstudio/py-shinyswatch
+        href: https://github.com/posit-dev/py-shinyswatch
+  page-footer:
+    center: |
+      shinyswatch v{{< env SHINYSWATCH_VERSION >}}
+
+format:
+  html:
+    theme: shiny.scss
+

docs/index.qmd

@@ -82,11 +82,12 @@ Example Shiny application:
 :::
 
 ::: {.content-visible when-format="html"}
+::: column-page-inset
 ```{shinylive-python}
 #| standalone: true
 #| components: [editor, viewer]
 #| layout: horizontal
-#| viewerHeight: 800
+#| viewerHeight: 400
 ## file: app.py
 {{< include "examples/darkly/app.py" >}}
 
@@ -96,6 +97,7 @@ Example Shiny application:
 
 ```
 :::
+:::
 
 > Note: When writing [shiny apps that use shinyswatch on shinylive.io](`{python} shinylive_example_url("darkly")`), remember to add `shinyswatch` to your `requirements.txt` file!
 
@@ -109,11 +111,12 @@ To add a theme picker to your app, add the theme picker UI and server functions
 :::
 
 ::: {.content-visible when-format="html"}
+::: column-page-inset
 ```{shinylive-python}
 #| standalone: true
 #| components: [editor, viewer]
 #| layout: horizontal
-#| viewerHeight: 800
+#| viewerHeight: 400
 ## file: app.py
 {{< include "examples/theme-picker/app.py" >}}
 
@@ -123,6 +126,7 @@ To add a theme picker to your app, add the theme picker UI and server functions
 
 ```
 :::
+:::
 
 ## Plot Theming
 
@@ -134,11 +138,12 @@ In the example below, try changing the theme and re-running the app to see how t
 :::
 
 ::: {.content-visible when-format="html"}
+::: column-page-inset
 ```{shinylive-python}
 #| standalone: true
 #| components: [editor, viewer]
 #| layout: horizontal
-#| viewerHeight: 800
+#| viewerHeight: 550
 ## file: app.py
 {{< include "examples/plot-theming/app.py" >}}
 
@@ -148,6 +153,7 @@ In the example below, try changing the theme and re-running the app to see how t
 
 ```
 :::
+:::
 
 ::: {.content-visible when-format="markdown"}
 ## Development