diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..4104f98 --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,51 @@ +# pkgdown workflow of the mlr3 ecosystem v0.1.0 +# https://github.com/mlr-org/actions +on: + push: + branches: + - main + pull_request: + branches: + - main + release: + types: + - published + workflow_dispatch: + +name: pkgdown + +jobs: + pkgdown: + runs-on: ubuntu-latest + + concurrency: + group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website + + - name: Install template + run: pak::pkg_install("mlr-org/mlr3pkgdowntemplate") + shell: Rscript {0} + + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) + shell: Rscript {0} + + - name: Deploy + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.6.3 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml new file mode 100644 index 0000000..01e55c3 --- /dev/null +++ b/pkgdown/_pkgdown.yml @@ -0,0 +1,41 @@ +url: https://mlr3forecast.mlr-org.com + +template: + bootstrap: 5 + light-switch: true + package: mlr3pkgdowntemplate + +development: + mode: auto + version_label: default + version_tooltip: "Version" + +toc: + depth: 3 + +navbar: + structure: + left: [reference, news, book] + right: [github, mattermost, stackoverflow, rss, lightswitch] + components: + home: ~ + reference: + icon: fa fa-file-alt + text: Reference + href: reference/index.html + mattermost: + icon: fa fa-comments + href: https://lmmisld-lmu-stats-slds.srv.mwn.de/mlr_invite/ + github: + icon: fa fa-github + href: https://github.com/mlr-org/mlr3forecast + book: + text: mlr3book + icon: fa fa-link + href: https://mlr3book.mlr-org.com + stackoverflow: + icon: fab fa-stack-overflow + href: https://stackoverflow.com/questions/tagged/mlr3 + rss: + icon: fa-rss + href: https://mlr-org.com/