Skip to content

Commit

Permalink
pkgdown: add roadmap + search + more
Browse files Browse the repository at this point in the history
  • Loading branch information
HenrikBengtsson committed Apr 7, 2021
1 parent 8a00b8f commit 632232f
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 1 deletion.
2 changes: 1 addition & 1 deletion DESCRIPTION
Expand Up @@ -24,7 +24,7 @@ Description: Implementation of the Future API on top of the 'batchtools' package
e.g. 'y <- future.apply::future_lapply(files, FUN = process)'.
License: LGPL (>= 2.1)
LazyLoad: TRUE
URL: https://github.com/HenrikBengtsson/future.batchtools
URL: https://future.batchtools.futureverse.org, https://github.com/HenrikBengtsson/future.batchtools
BugReports: https://github.com/HenrikBengtsson/future.batchtools/issues
RoxygenNote: 7.1.1
Roxygen: list(markdown = TRUE)
54 changes: 54 additions & 0 deletions pkgdown/_pkgdown.yml
@@ -0,0 +1,54 @@
url: https://future.batchtools.futureverse.org

home:
links:
- text: Roadmap/Milestones
href: https://github.com/HenrikBengtsson/future.batchtools/milestones
- text: The Futureverse Project
href: https://www.futureverse.org/

navbar:
structure:
right: [futureverse, pkgs, cran, github]
components:
futureverse:
icon: fas fa-fast-backward
href: https://www.futureverse.org/
pkgs:
text: Packages
menu:
- text: BiocParallel.FutureParam
href: https://BiocParallel.FutureParam.futureverse.org
- text: doFuture
href: https://doFuture.futureverse.org
- text: furrr
href: https://furrr.futureverse.org
- text: future
href: https://future.futureverse.org
- text: future.apply
href: https://future.apply.futureverse.org
- text: future.batchtools
href: https://future.batchtools.futureverse.org
- text: future.callr
href: https://future.callr.futureverse.org
- text: future.tests
href: https://future.tests.futureverse.org
- text: globals
href: https://globals.futureverse.org
- text: listenv
href: https://listenv.futureverse.org
- text: parallelly
href: https://parallelly.futureverse.org
- text: progressr
href: https://progressr.futureverse.org
cran:
icon: fab fa-r-project
href: https://cloud.r-project.org/package=future.batchtools

template:
params:
docsearch:
api_key: aa6e02fc501886fb0f7c91ac4e300456
index_name: futureverse
algoliaOptions: { 'facetFilters': ['project:future.batchtools'] }
ganalytics: G-SB3EQSD9FR
44 changes: 44 additions & 0 deletions pkgdown/_pkgdown.yml.rsp
@@ -0,0 +1,44 @@
<%
pkgs <- c("globals", "listenv", "parallelly", "future", "future.apply", "furrr", "future.tests", "future.callr", "future.batchtools", "doFuture", "progressr", "BiocParallel.FutureParam")
pkgs <- sort(pkgs)
urls <- sprintf("https://%s.futureverse.org", pkgs)
names(urls) <- pkgs

file <- file.path(c(".", ".."), "DESCRIPTION")
file <- file[utils::file_test("-f", file)]
pkg <- read.dcf(file)[,"Package"]
%>
url: https://<%= pkg %>.futureverse.org

home:
links:
- text: Roadmap/Milestones
href: https://github.com/HenrikBengtsson/<%= pkg %>/milestones
- text: The Futureverse Project
href: https://www.futureverse.org/

navbar:
structure:
right: [futureverse, pkgs, cran, github]
components:
futureverse:
icon: fas fa-fast-backward
href: https://www.futureverse.org/
pkgs:
text: Packages
menu:
<% for (name in names(urls)) { %>
- text: <%= name %>
href: <%= urls[name] %>
<% } %>
cran:
icon: fab fa-r-project
href: https://cloud.r-project.org/package=<%= pkg %>

template:
params:
docsearch:
api_key: aa6e02fc501886fb0f7c91ac4e300456
index_name: futureverse
algoliaOptions: { 'facetFilters': ['project:<%= pkg %>'] }
ganalytics: G-SB3EQSD9FR

0 comments on commit 632232f

Please sign in to comment.