From b98da9661020ae07b50587e8134cc85a13458df8 Mon Sep 17 00:00:00 2001 From: atusy <30277794+atusy@users.noreply.github.com> Date: Fri, 9 Aug 2024 09:25:57 +0900 Subject: [PATCH] docs(pkgodown): build --- docs/404.html | 14 +- docs/LICENSE-text.html | 14 +- docs/LICENSE.html | 14 +- docs/articles/felp.html | 63 +++--- .../empty-anchor.js | 15 -- docs/articles/index.html | 14 +- docs/authors.html | 20 +- docs/index.html | 14 +- docs/news/index.html | 31 ++- docs/pkgdown.yml | 5 +- docs/reference/dummy.html | 14 +- docs/reference/felp.html | 24 +- docs/reference/fuzzyhelp.html | 32 +-- docs/reference/index.html | 16 +- docs/reference/question.html | 20 +- docs/reference/telp.html | 207 ------------------ docs/sitemap.xml | 59 ++--- 17 files changed, 163 insertions(+), 413 deletions(-) delete mode 100644 docs/articles/felp_files/accessible-code-block-0.0.1/empty-anchor.js delete mode 100644 docs/reference/telp.html diff --git a/docs/404.html b/docs/404.html index 6758f4c..df31ec8 100644 --- a/docs/404.html +++ b/docs/404.html @@ -25,7 +25,7 @@ - +
@@ -59,7 +59,7 @@
  • - +
    • @@ -70,7 +70,7 @@
    - +
    @@ -98,16 +98,16 @@

    Page not found (404)

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 08f0914..225df58 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -3,7 +3,7 @@ - +
    @@ -34,14 +34,14 @@
    - +
    @@ -68,15 +68,15 @@

    License

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 134c1fb..3473f94 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -3,7 +3,7 @@ - +
    @@ -34,14 +34,14 @@
    - +
    @@ -72,15 +72,15 @@

    MIT License

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/felp.html b/docs/articles/felp.html index 9e5884b..52e7455 100644 --- a/docs/articles/felp.html +++ b/docs/articles/felp.html @@ -12,21 +12,19 @@ - + - - - +
    @@ -60,7 +58,7 @@
  • - +
    • @@ -71,7 +69,7 @@
    - +
    @@ -92,7 +90,7 @@

    felp

    } 
    -library(felp)
+library(felp)
 library(printr) # To include documents output by `?` in this article

    The felp package provides

    -
    - - +
    felp R Documentation
    -

    Functional help which displays structure of an object in addition to help

    +

    Functional help which displays structure of an object in addition to help

    Description

    @@ -171,7 +167,7 @@

    Arguments

    - + - + - +
    topictopic

    usually, a name or character string specifying the topic for which help is sought. A character string (enclosed in @@ -187,7 +183,7 @@

    Arguments
    packagepackage

    a name or character vector giving the packages to look into for documentation, or NULL. By default, all packages @@ -196,7 +192,7 @@

    Arguments
    ......

    Arguments passed on to utils::help @@ -242,8 +238,7 @@

    Examples

    - - +
    @@ -255,13 +250,11 @@

    felp(dataset)
    -
    - - +
    dummy R Documentation
    -

    A dummy data for felp

    +

    A dummy data for felp

    Description

    @@ -279,8 +272,7 @@

    Format

    An object of class list of length 2.

    - -
    +

    @@ -295,7 +287,7 @@

    felp(package)felp(package)felp(package) - -

    + @@ -352,16 +343,16 @@

    felp(package)

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/felp_files/accessible-code-block-0.0.1/empty-anchor.js b/docs/articles/felp_files/accessible-code-block-0.0.1/empty-anchor.js deleted file mode 100644 index ca349fd..0000000 --- a/docs/articles/felp_files/accessible-code-block-0.0.1/empty-anchor.js +++ /dev/null @@ -1,15 +0,0 @@ -// Hide empty tag within highlighted CodeBlock for screen reader accessibility (see https://github.com/jgm/pandoc/issues/6352#issuecomment-626106786) --> -// v0.0.1 -// Written by JooYoung Seo (jooyoung@psu.edu) and Atsushi Yasumoto on June 1st, 2020. - -document.addEventListener('DOMContentLoaded', function() { - const codeList = document.getElementsByClassName("sourceCode"); - for (var i = 0; i < codeList.length; i++) { - var linkList = codeList[i].getElementsByTagName('a'); - for (var j = 0; j < linkList.length; j++) { - if (linkList[j].innerHTML === "") { - linkList[j].setAttribute('aria-hidden', 'true'); - } - } - } -}); diff --git a/docs/articles/index.html b/docs/articles/index.html index 1daa684..de0b665 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -3,7 +3,7 @@ - +
    @@ -34,14 +34,14 @@
    - +
    @@ -65,15 +65,15 @@

    All vignettes

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/authors.html b/docs/authors.html index e092d47..cbd2caf 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -3,7 +3,7 @@ - +
    @@ -34,14 +34,14 @@
    - +
    @@ -50,7 +50,7 @@

    Authors and Citation

    - +

    • Atsushi Yasumoto. Author, copyright holder, maintainer.

      @@ -66,13 +66,13 @@

      Citation

      Yasumoto A (2024). felp: Functional Help for Functions, Objects, and Packages. -R package version 0.5.0.9999, https://github.com/atusy/felp, https://felp.atusy.net/. +R package version 0.6.0, https://github.com/atusy/felp, https://felp.atusy.net/. 

      @Manual{,
   title = {felp: Functional Help for Functions, Objects, and Packages},
   author = {Atsushi Yasumoto},
   year = {2024},
-  note = {R package version 0.5.0.9999, https://github.com/atusy/felp},
+  note = {R package version 0.6.0, https://github.com/atusy/felp},
   url = {https://felp.atusy.net/},
 }
      @@ -87,15 +87,15 @@

      Citation

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/index.html b/docs/index.html index 5875a9e..0d47720 100644 --- a/docs/index.html +++ b/docs/index.html @@ -26,7 +26,7 @@ - +
    @@ -60,7 +60,7 @@
  • - +
    • @@ -71,7 +71,7 @@
    - +
    @@ -210,16 +210,16 @@

    Dev status

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/news/index.html b/docs/news/index.html index ad76820..320b8e5 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -1,9 +1,9 @@ -Changelog • felpChangelog • felp - +
    @@ -34,14 +34,14 @@
    - +
    @@ -51,8 +51,15 @@

    Changelog

    -

    felp 0.5.1

    -
    • Fixed fuzzyhelp() not showing preview on RStudio Server.
      • +

      felp 0.6.0

      +
      • Fixed fuzzyhelp() not showing preview on RStudio Server (#23).
        • +
      • Remove covr and rmarkdown from suggests (#24).
        • +
      • Improved Shiny UI of fuzzyhelp() (#25) +
        • resize with CSS instead of JS so that resize works properly on Chrome and Firefox
          • +
        • increase height of help viewer
          • +
        • theming TOC to be striped, be dense, and to highlight hovered-row
          • +
        • +
      • Improved performance of fuzzyhelp() (#26)

    felp 0.5.02024-04-18

    @@ -150,11 +157,11 @@

    Help wanted❯ checking Rd \usage sections ... WARNING Undocumented arguments in documentation object '?' ‘e1’ ‘e2’ - + Bad \usage lines found in documentation object '?': <unescaped bksl>method{?}{function}(e1, e2) <unescaped bksl>method{?}{default}(e1, e2) - + Functions with \usage entries need to have the appropriate \alias entries, and all their arguments documented. The \usage entries must correspond to syntactically valid R code. @@ -182,15 +189,15 @@

    felp 0.1.0 -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index bf9a2a8..7eb42c3 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,7 +1,6 @@ pandoc: 3.2.1 -pkgdown: 2.0.9 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: felp: felp.html -last_built: 2024-08-05T00:26Z - +last_built: 2024-08-09T00:23Z diff --git a/docs/reference/dummy.html b/docs/reference/dummy.html index c058a93..21ab8a8 100644 --- a/docs/reference/dummy.html +++ b/docs/reference/dummy.html @@ -3,7 +3,7 @@ - +
    @@ -34,14 +34,14 @@
    - +
    @@ -76,15 +76,15 @@

    Format

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/felp.html b/docs/reference/felp.html index 9a9afc0..b84a2a1 100644 --- a/docs/reference/felp.html +++ b/docs/reference/felp.html @@ -4,7 +4,7 @@ - +
    @@ -35,14 +35,14 @@
    - +
    @@ -63,7 +63,9 @@

    Functional help which displays structure of an object in addition to help

    Arguments

    -
    topic
    + + +
    topic

    usually, a name or character string specifying the topic for which help is sought. A character string (enclosed in explicit single or double quotes) is always taken as naming a topic.

    @@ -74,14 +76,14 @@

    Arguments

    See ‘Details’ for what happens if this is omitted.

    -
    package
    +
    package

    a name or character vector giving the packages to look into for documentation, or NULL. By default, all packages whose namespaces are loaded are used. To avoid a name being deparsed use e.g. (pkg_ref) (see the examples).

    -
    ...
    +
    ...

    Arguments passed on to utils::help

    lib.loc

    a character vector of directory names of R libraries, or NULL. The default value of NULL corresponds to all @@ -100,7 +102,7 @@

    Arguments

    Possible values are "text", "html" and "pdf". Case is ignored, and partial matching is allowed.

    - +
    @@ -140,15 +142,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/fuzzyhelp.html b/docs/reference/fuzzyhelp.html index 8d9847e..bb9218c 100644 --- a/docs/reference/fuzzyhelp.html +++ b/docs/reference/fuzzyhelp.html @@ -9,7 +9,7 @@ - +
    @@ -40,14 +40,14 @@
    - +
    @@ -78,33 +78,33 @@

    Fuzzily Search Help and View the Selection

    Arguments

    -
    query
    + + +
    query

    An initial query to search for the help system.

    -
    method
    +
    method

    A fuzzy match method to use. Choices are "fzf" and "lv" (levenstein). The method "lv" is faster but can be less accurate. The default value can be tweaked by options(fuzzyhelp.method = "lv").

    -
    background
    +
    background

    Whether to run a shiny gadget in a background process. The default value is TRUE and can be changed by option(fuzzyhelp.background = FALSE).

    -
    viewer
    -

    Specify where the gadget should be displayed--viewer pane, -dialog window, or external browser--by passing in a call to one of the +

    viewer
    +

    Specify where the gadget should be displayed–viewer pane, +dialog window, or external browser–by passing in a call to one of the viewer() functions.

    Value

    - - -

    If the background argument is TRUE, then the return value inherits from +

    If the background argument is TRUE, then the return value inherits from callr::r_bg(). Otherwise, NULL is returned.

    @@ -135,15 +135,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/index.html b/docs/reference/index.html index 3aa389e..034a27a 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,9 +1,9 @@ -Function reference • felpPackage index • felp - +
    @@ -34,14 +34,14 @@
    - +
    @@ -82,15 +82,15 @@

    All functions
    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/question.html b/docs/reference/question.html index 8b9eab1..f781159 100644 --- a/docs/reference/question.html +++ b/docs/reference/question.html @@ -6,7 +6,7 @@ - +
    @@ -37,14 +37,14 @@
    - +
    @@ -67,12 +67,14 @@

    Functional help with ? operator

    Arguments

    -
    e1
    + + +
    e1

    A topic of document. Refer to topic argument described in utils::`?`.

    -
    e2
    +
    e2

    . and p have special meanings as documented above. Otherwise, e2 is same as type argument of utils::`?`.

    @@ -123,15 +125,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/telp.html b/docs/reference/telp.html deleted file mode 100644 index 66ecc2a..0000000 --- a/docs/reference/telp.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - - - -Translated Help — telp • felp - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - - -
    - -
    -
    -
    -

    Translated Help

    - Source: R/telp.R - -
    - -
    -

    The translated help is available when topic belongs to a package installed -from CRAN and the system is online. Otherwise, normal help will be shown. -The source of the help is powered by 'RDocumentation', and -the translation is powered by 'Google Translate.

    -
    - - 
    telp(topic, package = NULL, translate_to = "default", ...)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    topic

    usually, a name or character string specifying the - topic for which help is sought. A character string (enclosed in - explicit single or double quotes) is always taken as naming a topic.

    -

    If the value of topic is a length-one - character vector the topic is taken to be the value of the only - element. Otherwise topic must be a name or a reserved - word (if syntactically valid) or character string.

    -

    See ‘Details’ for what happens if this is omitted.

    package

    a name or character vector giving the packages to look - into for documentation, or NULL. By default, all packages - whose namespaces are loaded are used. To avoid a name being deparsed use e.g. - (pkg_ref) (see the examples).

    translate_to

    The help document will be translated to the specified -language (e.g., "ja" for Japanese and "de" for German). If "default", -the function looks up getOption("telp_translate_to", "en").

    ...

    Arguments passed to utils::help

    - - -

    Examples

    - 
    if (FALSE) {
-telp(help)
-}
    -
    - -
    - - -
    -
    -

    Developed by Atsushi Yasumoto.

    -
    - -
    -

    Site built with pkgdown 1.4.1.

    -
    - -
    -
    - - - - - - - - diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 069946d..d92dd9c 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1,45 +1,16 @@ - - - - /404.html - - - /LICENSE-text.html - - - /LICENSE.html - - - /articles/felp.html - - - /articles/index.html - - - /authors.html - - - /index.html - - - /news/index.html - - - /reference/dummy.html - - - /reference/felp.html - - - /reference/fuzzyhelp.html - - - /reference/index.html - - - /reference/question.html - - - /reference/telp.html - + +/404.html +/LICENSE-text.html +/LICENSE.html +/articles/felp.html +/articles/index.html +/authors.html +/index.html +/news/index.html +/reference/dummy.html +/reference/felp.html +/reference/fuzzyhelp.html +/reference/index.html +/reference/question.html +