Merge pull request #141 from stan-dev/new-pkgdown-theme

New pkgdown theme

Author: jgabry

.github/workflows/pkgdown.yaml

@@ -0,0 +1,55 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  # build dev site on merged pushes
+  push:
+    branches: [main, master]
+  # build full site on releases
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+      cancel-in-progress: true
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::., any::withr, stan-dev/pkgdown-config
+
+      - name: Build site
+        run: |
+          withr::with_envvar(
+            c("NOT_CRAN" = "true"), # this should already be set by setup-r@v2? keeping because vignettes don't build otherwise
+            pkgdown::build_site_github_pages(
+              lazy = FALSE, # change to TRUE if runner times out.
+              run_dont_run = TRUE,
+              new_process = TRUE
+            )
+          )
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

DESCRIPTION

@@ -53,6 +53,6 @@ Suggests:
     roxygen2 (>= 6.0.1),
     rmarkdown,
     rstudioapi
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 VignetteBuilder: knitr
 Roxygen: list(markdown = TRUE)

R/rstan_create_package.R

@@ -21,7 +21,7 @@
 #' @aliases rstan_package_skeleton
 #'
 #' @description
-#'   \if{html}{\figure{stanlogo.png}{options: width="25" alt="https://mc-stan.org/about/logo/"}}
+#'   \if{html}{\figure{logo.svg}{options: width="25" alt="https://mc-stan.org/about/logo/"}}
 #'   The `rstan_create_package()` function helps get you started developing a
 #'   new \R package that interfaces with Stan via the \pkg{rstan} package. First
 #'   the basic package structure is set up via [usethis::create_package()].

R/rstantools-package.R

@@ -5,7 +5,7 @@
 #'
 #' @description
 #' \if{html}{
-#'   \figure{stanlogo.png}{options: width="50" alt="mc-stan.org"}
+#'   \figure{logo.svg}{options: width="50" alt="mc-stan.org"}
 #' } *Stan Development Team*
 #'
 #' The \pkg{rstantools} package provides various tools for developers of \R

README.md

@@ -1,4 +1,4 @@
-# rstantools <img src="man/figures/stanlogo.png" align="right" width="120" />
+# rstantools <img src="man/figures/logo.svg" align="right" width="120" />
 
 <!-- badges: start -->
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/rstantools?color=blue)](https://cran.r-project.org/web/packages/rstantools)

_pkgdown.yml

@@ -0,0 +1,83 @@
+url: https://mc-stan.org/rstantools
+
+destination: "."
+
+template:
+  package: pkgdownconfig
+
+development:
+  mode: auto
+
+navbar:
+  title: "rstantools"
+
+  structure:
+    left: [home, vignettes, functions, news, pkgs, stan]
+    right: [search, bluesky, forum, github, lightswitch]
+
+  components:
+    pkgs:
+      text: Other Packages
+      menu:
+        - text: bayesplot
+          href: https://mc-stan.org/bayesplot
+        - text: cmdstanr
+          href: https://mc-stan.org/cmdstanr
+        - text: loo
+          href: https://mc-stan.org/loo
+        - text: posterior
+          href: https://mc-stan.org/posterior
+        - text: projpred
+          href: https://mc-stan.org/projpred
+        - text: rstan
+          href: https://mc-stan.org/rstan
+        - text: rstanarm
+          href: https://mc-stan.org/rstanarm
+        - text: shinystan
+          href: https://mc-stan.org/shinystan
+
+articles:
+  - title: "Recommendations for R package development with Stan"
+    desc: >
+      This vignette provides many recommendations for developers interested in
+      creating an R package that interface with Stan. Topics include
+      development best practices, precompiling Stan programs, R code and
+      documentation, and more.
+    contents:
+      - developer-guidelines
+  - title: "Step-by-step guide"
+    desc: >
+      This vignette walks through the steps required to set up a package with
+      a precompiled Stan model, from creating the initial package structure to
+      adding the precompiled Stan program and writing the R function that users
+      will call to fit the model.
+    contents:
+      - minimal-rstan-package
+
+reference:
+  - title: "Package structure"
+    desc: >
+      Creating the basic structure of a Stan-based R package or add
+      Stan programs to an existing package.
+    contents:
+      - rstantools-package
+      - rstan_create_package
+      - use_rstan
+      - rstan_config
+      - rstantools_load_code
+  - title: "Generics"
+    desc: >
+      S3 generics (and some default methods) for adding functionality
+      to your package using the same naming conventions as **rstanarm**
+      and other Stan-based R packages.
+    contents:
+      - bayes_R2
+      - log_lik
+      - loo-prediction
+      - posterior_interval
+      - posterior_epred
+      - posterior_linpred
+      - posterior_predict
+      - predictive_error
+      - predictive_interval
+      - prior_summary