Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A pkgdown website for data.table #3677

Merged
merged 62 commits into from
Sep 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
d6b0eee
Flag deprecated set2key as internal
hadley Jul 1, 2019
91d654e
First pass at organisation documentation topics into sections
hadley Jul 1, 2019
4b9fa21
Add github url to URL
hadley Jul 1, 2019
2071079
Use h1 and h2 in NEWS
hadley Jul 1, 2019
fa012ea
gitignore website
hadley Jul 1, 2019
37969d9
Rough first pass at readme/homepage
hadley Jul 3, 2019
58227b1
pass at improving ref index & fine-tuning homepage
Jul 4, 2019
47251a5
fix invalid yaml
jangorecki Aug 26, 2019
99aec2c
README simplify, use md for pkgdown(devel=F)
jangorecki Aug 26, 2019
786521b
use GH URL in dcf for pkgdown
jangorecki Aug 26, 2019
c3a911a
try render pkgdown
jangorecki Aug 26, 2019
d5ce7cf
build ignore pkgdown yml
jangorecki Aug 26, 2019
134ea33
script 0 note check, allow failure for pkgdown dev
jangorecki Aug 26, 2019
cf51185
pkgdown allow to publish
jangorecki Aug 26, 2019
9f586eb
plan pkgdown navbar
jangorecki Aug 26, 2019
5b68577
install pkgdown dependencies
jangorecki Aug 26, 2019
c23cf1d
proper install libxml2-dev for pkgdown
jangorecki Aug 26, 2019
bcd8d82
Merge branch 'master' into pkgdown
jangorecki Aug 26, 2019
41a5a2f
pkgdown devel=FALSE needs dt to be installed
jangorecki Aug 26, 2019
8746978
no need to ignnore, pkgdown runs in CI, not manually
jangorecki Aug 27, 2019
bc16fa3
align NEWS.0.md style to NEWS.md for pkgdown req
jangorecki Aug 27, 2019
ee5a45f
I dont think we need to ignore png here, one is already there
jangorecki Aug 27, 2019
b4bd2a7
CI install pkgs quiet
jangorecki Aug 27, 2019
db08909
after rmerge recent master does not fail anymore, disallow failure
jangorecki Aug 27, 2019
2860cbe
compiler flag _g_ should be disabled by default already
jangorecki Aug 27, 2019
5fe9298
Merge branch 'master' into pkgdown
jangorecki Aug 27, 2019
25b6aa0
tweak README accordiing to feedback
jangorecki Aug 27, 2019
307a76f
rename to more R-ish label
jangorecki Aug 27, 2019
152c9bd
depsy in unmaintainedand outdated, remove badge
jangorecki Aug 27, 2019
a998287
try https svg ref
jangorecki Aug 27, 2019
a0c5a6f
address as-cran NOTE abt pkg size, new images dont need to be in pkg …
jangorecki Aug 27, 2019
0c8260f
Usage of SD vignette cleanup to reduce pkg size
jangorecki Aug 27, 2019
e85ea0b
compiler flag _g_ IS NOT disabled by default
jangorecki Aug 27, 2019
881a4b5
add missing png to homepage
jangorecki Aug 27, 2019
1b4ccde
pkg size resolved, no more CRAN note, disallow failure
jangorecki Aug 27, 2019
cd89d39
add custom version tooltip
Aug 27, 2019
7cef6a4
Merge branch 'master' into pkgdown
Aug 27, 2019
dbe165b
Merge branch 'master' into pkgdown
jangorecki Aug 28, 2019
e51a2d2
version label always dev
jangorecki Aug 28, 2019
e01d704
inform in case of files overwritten by pkgdown
jangorecki Aug 28, 2019
f5227db
fix missing figures in vignette
jangorecki Aug 28, 2019
c921902
remove cformatting from title
jangorecki Aug 28, 2019
d42468a
align NEWS.md to pkgdown expected structure
jangorecki Aug 28, 2019
295e845
group manuals
jangorecki Aug 28, 2019
b7113e2
Merge branch 'master' into pkgdown
jangorecki Aug 29, 2019
ee0bb43
fix SD vign pkgdown missing plots
jangorecki Aug 29, 2019
6b0cc61
pkgdown manual fix warns
jangorecki Aug 29, 2019
34bbc7d
Merge branch 'master' into pkgdown
jangorecki Aug 29, 2019
f7615e1
add revdeps badges
jangorecki Aug 29, 2019
2046ee8
pkgdown now installs from root dir so need it clean, reorder tasks in…
jangorecki Aug 29, 2019
f0bb36f
add missing manual, reorder
jangorecki Aug 29, 2019
6e450a1
add depsy badge
jangorecki Aug 29, 2019
bef735e
Merge branch 'master' into pkgdown
jangorecki Aug 30, 2019
568cce4
mention copy in another section of manual
jangorecki Aug 30, 2019
6b99855
add GA tag
jangorecki Aug 30, 2019
2887991
Merge branch 'master' into pkgdown
jangorecki Sep 1, 2019
d9ce464
Merge branch 'master' into pkgdown
jangorecki Sep 4, 2019
a04c593
Merge branch 'master' into pkgdown
jangorecki Sep 6, 2019
f89acfc
rename coalesce to fcoalesce in pkgdown manual index
jangorecki Sep 6, 2019
ea7db96
use two urls again in desc file
jangorecki Sep 16, 2019
7e0e6a5
Merge branch 'master' into pkgdown
jangorecki Sep 16, 2019
7b361bf
Merge branch 'master' into pkgdown
jangorecki Sep 16, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,8 @@
^.*\.dll$
^rdatatable\.png$
^rdatatable\.svg$

^_pkgdown\.yml$
^pkgdown$
^cheatsheet\.png$
^logo\.png$
^vignettes/plots/figures$
29 changes: 20 additions & 9 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ build: # build data.table sources as tar.gz archive
dependencies:
- mirror-packages
script:
- Rscript -e 'install.packages("knitr", repos=file.path("file:",normalizePath("bus/mirror-packages/cran")))'
- Rscript -e 'install.packages("knitr", repos=file.path("file:",normalizePath("bus/mirror-packages/cran")), quiet=TRUE)'
- rm -r bus
- echo "Revision:" $CI_BUILD_REF >> ./DESCRIPTION
- R CMD build .
Expand Down Expand Up @@ -101,7 +101,7 @@ test-rel-lin: # most comprehensive tests, force all suggests, also integration
OPENBLAS_MAIN_FREE: "1"
TEST_DATA_TABLE_WITH_OTHER_PACKAGES: "TRUE"
script:
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies(c("DESCRIPTION","inst/tests/tests-DESCRIPTION"), which="all"))'
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies(c("DESCRIPTION","inst/tests/tests-DESCRIPTION"), which="all"), quiet=TRUE)'
- *copy-src
- rm -r bus
- *move-src
Expand Down Expand Up @@ -141,7 +141,7 @@ test-rel-cran-lin: # currently released R on Linux
- echo 'CFLAGS=-g0 -O2 -fopenmp -Wall -pedantic -fstack-protector-strong -D_FORTIFY_SOURCE=2'> ~/.R/Makevars # -g0 because -g increases datatable.so size from 0.5MB to 1.5MB and breaches 'installed package size <= 5MB' note
- echo 'CXXFLAGS=-g0 -O2 -fopenmp -Wall -pedantic -fstack-protector-strong -D_FORTIFY_SOURCE=2' >> ~/.R/Makevars
script:
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies("DESCRIPTION", which="most"))'
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies("DESCRIPTION", which="most"), quiet=TRUE)'
- *copy-src
- rm -r bus
- *move-src
Expand All @@ -159,7 +159,7 @@ test-dev-cran-lin: # R-devel on Linux
_R_CHECK_CRAN_INCOMING_: "TRUE"
_R_CHECK_CRAN_INCOMING_REMOTE_: "FALSE"
script:
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies("DESCRIPTION", which="most"))'
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies("DESCRIPTION", which="most"), quiet=TRUE)'
- *copy-src
- rm -r bus
- *move-src
Expand All @@ -174,7 +174,7 @@ test-310-cran-lin: # test stated R dependency (3.1.0) using Linux
_R_CHECK_CRAN_INCOMING_: "TRUE"
_R_CHECK_CRAN_INCOMING_REMOTE_: "FALSE"
script:
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies("DESCRIPTION", which="most"))'
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies("DESCRIPTION", which="most"), quiet=TRUE)'
- *copy-src
- rm -r bus
- *move-src
Expand All @@ -188,7 +188,7 @@ test-rel-win: # windows test and build binaries
R_BIN_VERSION: "3.6"
R_DIR: "R-3.6.0"
script:
- Rscript -e "source('ci.R'); install.packages(dcf.dependencies('DESCRIPTION', which='all'))"
- Rscript -e "source('ci.R'); install.packages(dcf.dependencies('DESCRIPTION', which='all'), quiet=TRUE)"
- *copy-src
- rm -r bus
- *move-src
Expand All @@ -207,7 +207,7 @@ test-dev-win: # R-devel on windows
TEST_DATA_TABLE_MEMTEST: "FALSE" # disabled as described in #3147
allow_failure: false
script:
- Rscript -e "source('ci.R'); install.packages(dcf.dependencies('DESCRIPTION', which='all'))"
- Rscript -e "source('ci.R'); install.packages(dcf.dependencies('DESCRIPTION', which='all'), quiet=TRUE)"
- *copy-src
- rm -r bus
- *move-src
Expand All @@ -223,7 +223,7 @@ test-dev-win: # R-devel on windows
variables:
R_BIN_VERSION: "3.6"
script:
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies("DESCRIPTION", which="all"))'
- Rscript -e 'source("ci.R"); install.packages(dcf.dependencies("DESCRIPTION", which="all"), quiet=TRUE)'
- *copy-src
- rm -r bus
- *move-src
Expand All @@ -241,6 +241,7 @@ integration: # merging all artifacts to produce single R repository and summarie
- linux
only:
- master
- pkgdown
dependencies:
- mirror-packages
- build
Expand All @@ -256,6 +257,12 @@ integration: # merging all artifacts to produce single R repository and summarie
R_BIN_VERSION: "3.6"
R_DEVEL_BIN_VERSION: "3.7"
script:
# pkgdown installs pkgs from "." so run at start to have clean root dir
- apt-get update -qq && apt-get install -y libxml2-dev
- mkdir -p /tmp/pkgdown/library
- R_LIBS_USER=/tmp/pkgdown/library Rscript -e 'install.packages("remotes", repos=Sys.getenv("CRAN_MIRROR"), quiet=TRUE); remotes::install_github("r-lib/pkgdown", repos=Sys.getenv("CRAN_MIRROR"), quiet=TRUE); pkgdown::build_site(override=list(destination="./pkgdown"))'
- mv cheatsheet.png pkgdown
# html manual, vignettes, repos, cran_web, cran_checks
- echo 'source("ci.R"); source("publish.R")' >> .Rprofile
# list of available test-* jobs dynamically based on bus/test-* directories
- Rscript -e 'cat("\ntest.jobs <- c(\n"); cat(paste0(" \"",list.files("bus",pattern="^test-"),"\" = \"data.table\""), sep=",\n"); cat(")\n")' >> .Rprofile
Expand Down Expand Up @@ -303,6 +310,9 @@ integration: # merging all artifacts to produce single R repository and summarie
- Rscript -e 'pdf.copy("data.table", "test-rel-lin")'
# web/checks/check_results_$pkg.html
- Rscript -e 'check.index("data.table", names(test.jobs))'
# pkgdown merge
- Rscript -e 'common_files<-function(path1, path2) intersect(list.files(path1, all.files=TRUE, no..=TRUE), list.files(path2, all.files=TRUE, no..=TRUE)); if (length(f<-common_files("pkgdown","bus/integration/cran"))) message(paste(c("Following artifacts will be overwritten by pkgdown artifacts:", paste0(" ", f)), collapse="\n")); q("no")'
- mv pkgdown/* bus/integration/cran/
# cleanup artifacts from other jobs
- mkdir tmpbus
- mv bus/$CI_BUILD_NAME tmpbus
Expand Down Expand Up @@ -363,13 +373,14 @@ docker-tags: # publish only on tagged commits, we use tags for version
IMAGE_TAG: $CI_COMMIT_TAG
<<: *docker

pages: # publish R repository, test jobs summaries, html documentation of all packages in repo
pages: # publish R repository, test jobs summaries, html documentation of all packages in repo, pkgdown
stage: deploy
environment: production
tags:
- linux
only:
- master
- pkgdown
image: ubuntu
dependencies:
- integration
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Suggests: bit64, curl, R.utils, knitr, xts, nanotime, zoo, yaml
SystemRequirements: zlib
Description: Fast aggregation of large data (e.g. 100GB in RAM), fast ordered joins, fast add/modify/delete of columns by group using no copies at all, list columns, friendly and fast character-separated-value read/write. Offers a natural and flexible syntax, for faster development.
License: MPL-2.0 | file LICENSE
URL: http://r-datatable.com
URL: http://r-datatable.com, https:/Rdatatable/data.table
BugReports: https:/Rdatatable/data.table/issues
VignetteBuilder: knitr
ByteCompile: TRUE
Loading