From b95a8c4dd92aaebb6bdced0d3df02fb55b210546 Mon Sep 17 00:00:00 2001 From: RossanaTat Date: Mon, 9 Sep 2024 13:16:28 -0400 Subject: [PATCH] try again --- .github/.gitignore | 1 + .github/workflows/pkgdown.yaml | 50 ++++++++++++++++++++++++++++++++++ .gitignore | 1 + _pkgdown.yml | 50 ++++++++++++++++++++++++++++++++++ 4 files changed, 102 insertions(+) create mode 100644 .github/.gitignore create mode 100644 .github/workflows/pkgdown.yaml create mode 100644 _pkgdown.yml diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..26efcf0 --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,50 @@ +# 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: + push: + branches: [issue_wbpage] + pull_request: + branches: [issue_wbpage] + release: + types: [published] + workflow_dispatch: + +name: pkgdown.yaml + +permissions: read-all + +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 }} + 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::. + needs: website + + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) + shell: Rscript {0} + + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index fbeba50..b9ce78b 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ +docs diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..8e3b6ef --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,50 @@ +url: https://rossanatat.github.io/syncdr/ +template: + bootstrap: 5 + bootswatch: sandstone + bslib: + primary: '#0072BB' +navbar: + bg: primary + type: dark + structure: + right: github + components: + github: + icon: fab fa-github fa-lg + href: https://github.com/RossanaTat/syncdr +articles: +- title: Usage + navbar: ~ + contents: + - visualizations + - asymmetric-synchronization + - symmetric-synchronization + - auxiliary-functions + - additional-options +reference: +- title: Main function + contents: compare_directories +- title: Visualizations + contents: + - display_sync_status + - display_dir_tree +- title: Asymmetric synchronization + contents: + - full_asym_sync_to_right + - common_files_asym_sync_to_right + - update_missing_files_asym_to_right + - partial_update_missing_files_asym_to_right +- title: Symmetric synchronization + contents: + - full_symmetric_sync + - partial_symmetric_sync_common_files +- title: Additional functions + contents: + - toy_dirs + - copy_temp_environment + - search_duplicates + - print.syncdr_status +development: + mode: auto +