rename build_html_mans to build_dbs

Author: LiNk-NY

DESCRIPTION

@@ -19,12 +19,12 @@ Maintainer: Bioconductor Package Maintainer <[email protected]>
 Depends: R (>= 3.6.0)
 Imports: Biobase, graph (>= 1.9.26), methods, RBGL (>= 1.13.5), tools,
         utils, XML, RCurl, RUnit, BiocManager
-Suggests: BiocGenerics, knitr, commonmark, BiocStyle
+Suggests: BiocGenerics, BiocPkgTools, knitr, commonmark, BiocStyle
 Collate: AllClasses.R AllGenerics.R as-methods.R htmlDoc-methods.R
         htmlFilename-methods.R htmlValue-methods.R show-methods.R
         getPackNames.R packageDetails.R pump.R repository.R showvoc.R
         getPackageNEWS.R validation_tests.R recommendBiocViews.R
-	dump_concept.R build_html_mans.R
+	dump_concept.R build_dbs.R
 VignetteBuilder: knitr
 RoxygenNote: 7.3.2
 Encoding: UTF-8

NAMESPACE

@@ -39,9 +39,8 @@ exportMethods("coerce", "show", "htmlDoc", "htmlValue", "htmlFilename")
 
 export("writeBiocViews", "getBiocViews", "write_VIEWS", "write_REPOSITORY",
        "genReposControlFiles", "extractVignettes", "extractManuals",
-       ## html manual functions
-       "build_db_from_source", "build_meta_aliases_db",
-       "build_meta_rdxrefs_db", "build_html_mans",
+       ## build db functions
+       "build_db_from_source", "build_meta_aliases_db", "build_meta_rdxrefs_db",
        ##
        "extractCitations", "getCurrentbiocViews",
        "extractNEWS", "extractHTMLDocuments", "extractTopLevelFiles",

R/build_html_mans.R renamed to R/build_dbs.R

@@ -1,5 +1,4 @@
-
-#' @name html-manuals
+#' @name build-dbs
 #'
 #' @title Helper functions to generate HTML pages for reference manuals
 #'
@@ -81,7 +80,7 @@ build_db_from_source <- function(package_dir, reposRoot) {
     message(xtofile)
 }
 
-#' @rdname html-manuals
+#' @rdname build-dbs
 #'
 #' @param web_dir `character(1)` The `web/packages` local directory that is
 #'   also hosted on the website e.g., for CRAN
@@ -132,7 +131,7 @@ build_meta_aliases_db <-
 
 is_file <- function(x) file.exists(x) && !file.info(x)[["isdir"]]
 
-#' @rdname html-manuals
+#' @rdname build-dbs
 #'
 #' @param rdxrefs_db_file `character(1)` The file path to `rdxrefs.rds` file
 #'   generated by the `build_db_from_source` function.
@@ -172,49 +171,3 @@ build_meta_rdxrefs_db <-
 
     db[sort(names(db))]
 }
-
-#' @rdname html-manuals
-#'
-#' @param package_dirs `character()` A vector of local source package
-#'   directories.
-#'
-#' @examples
-#' if (interative()) {
-#'     library(BiocPkgTools)
-#'     bioc_sub <- pkgBiocDeps(
-#'         "SummarizedExperiment", pkgType = "software",
-#'         recursive = TRUE, only.bioc = TRUE
-#'     )
-#'     bioc_sub <- unlist(bioc_sub, use.names = FALSE)
-#'
-#'     ## generate from Bioc package source dirs
-#'     packages <- file.path(normalizePath("~/bioc"), bioc_sub)
-#'     reposRoot <- "~/minibioc/packages/3.20/bioc"
-#'
-#'     build_html_mans(packages, reposRoot)
-#' }
-#' @export
-build_html_mans <- function(package_dirs, reposRoot) {
-    packages <- basename(package_dirs)
-    man_dir <- file.path(reposRoot, "manuals")
-    if (!dir.exists(man_dir)) dir.create(man_dir, recursive = TRUE)
-    outfiles <- file.path(man_dir, packages, "man", paste0(packages, ".html"))
-    outdirs <- dirname(outfiles)
-    for (i in seq_along(package_dirs)) {
-        if (!dir.exists(outdirs[i]))
-            dir.create(outdirs[i], recursive = TRUE)
-        tools::pkg2HTML(
-            dir = package_dirs[i],
-            out = outfiles[i],
-            hooks = list(
-                pkg_href = function(pkg) {
-                    sprintf(
-                        "../../%s/man/%s.html",
-                        pkg, pkg
-                    )
-                }
-            )
-        )
-    }
-    outfiles
-}