Update for pkgdown bs5 (#668)

* initial update for pkgdown bs5 * reorganize the navbar * update yamls and add descriptions for vignettes * Edits to pkgdown update * Don't need old favicons here Co-authored-by: Julia Silge <[email protected]>
tidymodels · Feb 28, 2022 · be1ffdb · be1ffdb
1 parent 3e2447c
commit be1ffdb
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 56 deletions.
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -1,18 +1,22 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# 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
-# Add Config/Needs/website: tidyverse/tidytemplate to DESCRIPTION
 on:
   push:
     branches: [main, master]
-    tags: ['*']
   pull_request:
     branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
 
 name: pkgdown
 
 jobs:
   pkgdown:
     runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
@@ -26,13 +30,9 @@ jobs:
 
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: r-lib/pkgdown
+          extra-packages: any::pkgdown, local::.
           needs: website
 
-      - name: Install dev reticulate
-        run: pak::pkg_install('rstudio/reticulate')
-        shell: Rscript {0}
-
       - name: Install Miniconda
         # conda can fail at downgrading python, so we specify python version in advance
         env:
@@ -45,17 +45,14 @@ jobs:
           tensorflow::install_tensorflow(version='2.7', conda_python_version = NULL)
         shell: Rscript {0}
 
-      - name: Install package
-        run: R CMD INSTALL .
-
       - name: Build site
-        if: github.event_name == 'pull_request'
-        run: |
-          Rscript -e 'pkgdown::build_site()'
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
 
-      - name: Deploy package
-        if: github.event_name == 'push'
-        run: |
-          git config --local user.name "$GITHUB_ACTOR"
-          git config --local user.email "[email protected]"
-          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ derby.log
 logs/*
 revdep/*
 docs*
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -13,7 +13,8 @@ Description: A common interface is provided to allow users to specify a
     different functions or computational engines (e.g. 'R', 'Spark',
     'Stan', etc).
 License: MIT + file LICENSE
-URL: https://parsnip.tidymodels.org, https://github.com/tidymodels/parsnip
+URL: https://github.com/tidymodels/parsnip,
+    https://parsnip.tidymodels.org/
 BugReports: https://github.com/tidymodels/parsnip/issues
 Depends:
     R (>= 2.10)
@@ -82,6 +83,7 @@ Config/Needs/website:
     rstanarm,
     tidymodels/tidymodels, 
     tidyverse/tidytemplate, 
+    rstudio/reticulate,
     xgboost
 Config/rcmdcheck/ignore-inconsequential-notes: true
 Encoding: UTF-8

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -1,11 +1,27 @@
-url: https://parsnip.tidymodels.org
+url: https://parsnip.tidymodels.org/
+
+navbar:
+  components:
+    home: ~
+    tutorials:
+      text: Learn more
+      menu:
+      - text: "Regression modeling"
+        href: https://www.tidymodels.org/learn/models/parsnip-ranger-glmnet/
+      - text: "Classification modeling"
+        href: https://www.tidymodels.org/learn/models/parsnip-nnet/
+      - text: "Making a parsnip model from scratch"
+        href: https://www.tidymodels.org/learn/develop/models/
 
 template:
+  package: tidytemplate
   bootstrap: 5
   bslib:
-    danger: "#CA225E"
     primary: "#CA225E"
-  package: tidytemplate
+
+  includes:
+      in_header: |
+        <script defer data-domain="parsnip.tidymodels.org,all.tidymodels.org" src="https://plausible.io/js/plausible.js"></script>
 
 development:
   mode: auto
@@ -72,7 +88,7 @@ reference:
       - translate
       - starts_with("update")
 
-  - title: Developer Tools
+  - title: Developer tools
     contents:
       - contr_one_hot
       - set_new_model
@@ -81,20 +97,3 @@ reference:
       - required_pkgs
       - required_pkgs.model_spec
       - req_pkgs
-
-navbar:
- components:
-   articles:
-    text: Articles
-    menu:
-    - text: Regression modeling
-      href: https://www.tidymodels.org/learn/models/parsnip-ranger-glmnet/
-    - text: Classification modeling
-      href: https://www.tidymodels.org/learn/models/parsnip-nnet/
-    - text: Making a parsnip model from scratch
-      href: https://www.tidymodels.org/learn/develop/models/
-    - text: Evaluating submodels with the same model object
-      href: articles/articles/Submodels.html
-    - text: Fitting and predicting with parsnip
-      href: articles/articles/Examples.html
-
diff --git a/vignettes/articles/Examples.Rmd b/vignettes/articles/Examples.Rmd
@@ -1,10 +1,13 @@
 ---
-title: "Fitting and Predicting with parsnip"
+title: "Fitting and predicting with parsnip"
+output: rmarkdown::html_vignette
+description: |
+  This vignette  show how to **fit** and **predict** with different 
+  combinations of model, mode, and engine.
 vignette: >
   %\VignetteEngine{knitr::rmarkdown}
-  %\VignetteIndexEntry{Fitting and Predicting with parsnip}
-output:
-  knitr:::html_vignette
+  %\VignetteIndexEntry{Fitting and predicting with parsnip}
+  %\VignetteEncoding{UTF-8}
 ---
 
 ```{r startup, include = FALSE}

diff --git a/vignettes/articles/Submodels.Rmd b/vignettes/articles/Submodels.Rmd
@@ -1,11 +1,13 @@
 ---
-title: "Evaluating Submodels with the Same Model Object"
+title: "Evaluating submodels with the same model object"
+output: rmarkdown::html_vignette
+description: |
+  You can use `multi_predict()` to evaluate submodels with the same model object 
+  and avoid having to fit any of the submodels.
 vignette: >
   %\VignetteEngine{knitr::rmarkdown}
-  %\VignetteIndexEntry{Evaluating Submodels with the Same Model Object}
-output:
-  knitr:::html_vignette:
-    toc: yes
+  %\VignetteIndexEntry{Evaluating submodels with the same model object}
+  %\VignetteEncoding{UTF-8}
 ---
 
 ```{r startup, include = FALSE}

diff --git a/vignettes/parsnip.Rmd b/vignettes/parsnip.Rmd
@@ -1,11 +1,13 @@
 ---
-title: "parsnip Basics"
+title: "Introduction to parsnip"
+output: rmarkdown::html_vignette
+description: |
+  The goal of parsnip is to provide a tidy, unified interface to models to avoid 
+  getting bogged down in the syntactical minutiae of the underlying software.
 vignette: >
   %\VignetteEngine{knitr::rmarkdown}
-  %\VignetteIndexEntry{parsnip Basics}
-output:
-  knitr:::html_vignette:
-    toc: yes
+  %\VignetteIndexEntry{Introduction to parsnip}
+  %\VignetteEncoding{UTF-8}
 ---
 
 ```{r ex_setup, include=FALSE}
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,3 +9,4 @@ derby.log @@
     logs/*
     revdep/*
     docs*
+    docs