From ce64f4e15e76545507d26e82c91b8d2238319823 Mon Sep 17 00:00:00 2001 From: ahasverus Date: Mon, 23 Oct 2023 14:55:19 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20FRBCesab?= =?UTF-8?q?/rcompendium@3797f271575530e21a68887bfbc404027432dc35=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- news/index.html | 3 --- pkgdown.yml | 2 +- reference/add_citation.html | 21 ++------------------- reference/add_github_actions_citation.html | 4 +++- 4 files changed, 6 insertions(+), 24 deletions(-) diff --git a/news/index.html b/news/index.html index fe504df..05dd3cf 100644 --- a/news/index.html +++ b/news/index.html @@ -83,9 +83,6 @@

rcompen
  • diff --git a/pkgdown.yml b/pkgdown.yml index 7fd45a1..9ae98b6 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -5,7 +5,7 @@ articles: developing_a_package: developing_a_package.html rcompendium: rcompendium.html working_with_a_compendium: working_with_a_compendium.html -last_built: 2023-10-23T12:28Z +last_built: 2023-10-23T14:54Z urls: reference: https://frbcesab.github.io/rcompendium/reference article: https://frbcesab.github.io/rcompendium/articles diff --git a/reference/add_citation.html b/reference/add_citation.html index 7c96205..40d5b35 100644 --- a/reference/add_citation.html +++ b/reference/add_citation.html @@ -1,17 +1,7 @@ Create a CITATION file — add_citation • rcompendium @@ -80,14 +70,7 @@

    Create a CITATION file

    This function creates a CITATION file in the folder inst/. This file contains a BiBTeX entry to cite the package as a manual. User will need to edit by hand some information (title, version, etc.).

    -

    Two additional files are also created:

    • a CITATION.cff file: a plain text file with human- and machine-readable -citation information for software. This file is a feature introduced by -GitHub. For more information: -https://ropensci.org/blog/2021/11/23/cffr/.

      • -

    • a .github/workflows/update-citation-cff.yaml file: a configuration file -to setup GitHub Actions to update the CITATION.cff each time the -DESCRIPTION file or the inst/CITATION is modified.

      • -
    + 
    add_citation(
diff --git a/reference/add_github_actions_citation.html b/reference/add_github_actions_citation.html
index ceb4f7f..f777cf4 100644
--- a/reference/add_github_actions_citation.html
+++ b/reference/add_github_actions_citation.html
@@ -3,7 +3,8 @@
 to update the CITATION.cff.
 This workflow is derived
 from https://github.com/r-lib/actions/tree/v2-branch/examples.
-This file will be written as .github/workflows/update-citation-cff.yaml.">
@@ -74,6 +75,7 @@ 
    Setup GitHub Actions to update CITATION.cff
    
 This workflow is derived
 from https://github.com/r-lib/actions/tree/v2-branch/examples.
 This file will be written as .github/workflows/update-citation-cff.yaml.
    
+
    This function also create the CITATION.cff using the package cffr.