[DOC] Host documentation on GitHub Pages

[tbouffard]

see

• https://www.rostrum.blog/2020/08/09/ghactions-pkgs/#example-r2eng-package
• https://pkgdown.r-lib.org/

Generate and deploy the site with GitHub actions

• see https://pkgdown.r-lib.org/articles/pkgdown.html#publishing
  • https://github.com/matt-dray/r2eng/blob/master/.github/workflows/pkgdown.yaml
  • https://github.com/cynkra/dm/blob/main/.github/workflows/pkgdown.yaml

Tasks

• Configure the repository: we are going to use GH Actions to publish (no branch) like done in
• Configure the GH workflow
• Add the url to the repo settings on GH
• Display the environment in the repository home
• Once deployed, promote the site in the package DESCRIPTION file. See https://pkgdown.r-lib.org/articles/pkgdown.html#promoting