add family tags and _pkgdown file; closes #24

Author: mpadge

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: allcontributors
 Title: Acknowledge all Contributors to a Project
-Version: 0.0.2.032
+Version: 0.0.2.033
 Authors@R: 
     person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre"))
 Description: Acknowledge all contributors to a project via a single
@@ -30,4 +30,4 @@ VignetteBuilder:
 Encoding: UTF-8
 Language: en-GB
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.1

NEWS.md

@@ -3,3 +3,4 @@
 Minor changes:
 
 - Add new `exclude_issues` parameter to main functions
+- Add `_pkgdown` file for function reference topics

R/add-contributors.R

@@ -57,6 +57,7 @@
 #' writeLines ("", f) # blank file in tempdir()
 #' add_contributors (repo = ".", files = f)
 #' }
+#' @family main
 #' @export
 add_contributors <- function (repo = ".",
                               ncols = 7,

R/github.R

@@ -12,6 +12,7 @@
 #' \dontrun{
 #' get_contributors (org = "ropenscilabs", repo = "allcontributors")
 #' }
+#' @family main
 #' @export
 get_contributors <- function (org, repo,
                               type = c ("code", "issues", "discussion"),
@@ -84,6 +85,7 @@ get_contributors <- function (org, repo,
 #' \dontrun{
 #' get_gh_code_contributors (org = "ropenscilabs", repo = "allcontributors")
 #' }
+#' @family github
 #' @export
 get_gh_code_contributors <- function (org, repo, alphabetical = FALSE) {
 
@@ -207,6 +209,7 @@ get_issues_qry <- function (gh_cli, org, repo, end_cursor = NULL) {
 #' \dontrun{
 #' get_gh_issue_people (org = "ropenscilabs", repo = "allcontributors")
 #' }
+#' @family github
 #' @export
 get_gh_issue_people <- function (org, repo, exclude_issues = NULL) {
 
@@ -292,6 +295,7 @@ get_gh_issue_people <- function (org, repo, exclude_issues = NULL) {
 #' \dontrun{
 #' get_gh_issue_titles (org = "ropenscilabs", repo = "allcontributors")
 #' }
+#' @family github
 #' @export
 get_gh_issue_titles <- function (org, repo) {
 
@@ -340,6 +344,7 @@ get_gh_issue_titles <- function (org, repo) {
 #' \dontrun{
 #' get_gh_contrib_issue (org = "ropenscilabs", repo = "allcontributors")
 #' }
+#' @family github
 #' @export
 get_gh_contrib_issue <- function (org, repo) {
 

_pkgdown.yml

@@ -0,0 +1,12 @@
+url: https://docs.ropensci.org/allcontributors
+
+figures:
+  dev: grDevices::png
+
+reference:
+- title: Main functions
+  contents:
+  - has_concept("main")
+- title: GitHub issue functions
+  contents:
+  - has_concept("github")

codemeta.json

@@ -10,7 +10,7 @@
   "codeRepository": "https://github.com/ropenscilabs/allcontributors",
   "issueTracker": "https://github.com/ropenscilabs/allcontributors/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.0.2.032",
+  "version": "0.0.2.033",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",

makefile

@@ -1,15 +1,25 @@
 LFILE = README
 
-all: knith #open 
+#all: insert knith #open 
+all: init build
+
+init:
+	echo "pkgdown::init_site()" | R --no-save -q
+
+build:
+	echo "pkgdown::build_site()" | R --no-save -q
 
 knith: $(LFILE).Rmd
 	echo "rmarkdown::render('$(LFILE).Rmd',output_file='$(LFILE).html')" | R --no-save -q
 
 knitr: $(LFILE).Rmd
-	echo "rmarkdown::render('$(LFILE).Rmd',rmarkdown::md_document(variant='gfm'))" | R --no-save -q
+	echo "rmarkdown::render('$(LFILE).Rmd',output_file='$(LFILE).md')" | R --no-save -q
+
+open:
+	xdg-open docs/index.html &
 
-open: $(LFILE).html
-	xdg-open $(LFILE).html &
+check:
+	Rscript -e 'library(pkgcheck); checks <- pkgcheck(); print(checks); summary (checks)'
 
 clean:
 	rm -rf *.html *.png README_cache