Add website docs.

r-world-devs · Sep 29, 2023 · ac0b917 · ac0b917
1 parent c401d3d
commit ac0b917
Show file tree

Hide file tree

Showing 139 changed files with 30,567 additions and 1,531 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,5 +4,4 @@
 .Ruserdata
 example_workflow_Roche.R
 example_branch.R
-docs
 inst/doc
diff --git a/R/EngineGraphQL.R b/R/EngineGraphQL.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @importFrom dplyr distinct mutate relocate filter
 #'
 #' @title A EngineGraphQL class

diff --git a/R/EngineGraphQLGitHub.R b/R/EngineGraphQLGitHub.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @importFrom dplyr distinct mutate filter
 #'
 #' @title A EngineGraphQLGitHub class

diff --git a/R/EngineGraphQLGitLab.R b/R/EngineGraphQLGitLab.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @importFrom dplyr relocate
 #'
 #' @title A EngineGraphQLGitLab class

diff --git a/R/EngineRest.R b/R/EngineRest.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @importFrom httr2 request req_headers req_perform resp_body_json
 #' @importFrom cli cli_abort col_green
 #' @importFrom rlang %||%

diff --git a/R/EngineRestGitHub.R b/R/EngineRestGitHub.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @title A EngineRestGitHub class
 #' @description A class for methods wrapping GitHub's REST API responses.
 EngineRestGitHub <- R6::R6Class("EngineRestGitHub",

diff --git a/R/EngineRestGitLab.R b/R/EngineRestGitLab.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @title A EngineRestGitLab class
 #' @description A class for methods wrapping GitLab's REST API responses.
 EngineRestGitLab <- R6::R6Class("EngineRestGitLab",

diff --git a/R/GQLQueryGitHub.R b/R/GQLQueryGitHub.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @title A GQLQueryGitHub class
 #' @description A class with methods to build GraphQL Queries for GitHub.
 

diff --git a/R/GQLQueryGitLab.R b/R/GQLQueryGitLab.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @title A GQLQueryGitLab class
 #' @description A class with methods to build GraphQL Queries for GitLab.
 

diff --git a/R/GitHost.R b/R/GitHost.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @importFrom R6 R6Class
 #' @importFrom rlang expr
 #' @importFrom cli cli_alert_danger cli_alert_success

diff --git a/R/GitStats.R b/R/GitStats.R
@@ -1,3 +1,4 @@
+#' @noRd
 #' @importFrom R6 R6Class
 #' @importFrom cli cli_alert_info cli_alert_success cli_alert_warning col_yellow
 #' @importFrom data.table rbindlist :=

diff --git a/README.Rmd b/README.Rmd
@@ -35,7 +35,7 @@ Please remember to have your access tokens stored as environment variables: `GIT
 
 ### Scope of tokens
 
-In the spirit of good practice of setting minimal scope of access to tokens for `GitStats` to work you need:
+For `GitStats` to work you need:
 
 - [GitHub] `public_repo`, `read:org` and `read:user` scopes,
 - [GitLab] `read_api` scope.

diff --git a/README.md b/README.md
@@ -28,8 +28,7 @@ GitLab API.
 
 ### Scope of tokens
 
-In the spirit of good practice of setting minimal scope of access to
-tokens for `GitStats` to work you need:
+For `GitStats` to work you need:
 
 - \[GitHub\] `public_repo`, `read:org` and `read:user` scopes,
 - \[GitLab\] `read_api` scope.

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -0,0 +1,11 @@
+url: ~
+template:
+  bootstrap: 5
+reference:
+- contents:
+  - matches("create_gitstats")
+  - starts_with("set_")
+  - starts_with("pull_")
+  - starts_with("get_")
+  - starts_with("reset")
+  - matches("gitstats_plot")
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html