Skip to content

Commit

Permalink
add info about pkgdown website generation
Browse files Browse the repository at this point in the history
  • Loading branch information
gdurif committed Jan 18, 2024
1 parent 8a14fc5 commit e2eaa9b
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
17 changes: 14 additions & 3 deletions rkeops/ci/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# RKeOps Continuous Integration (CI)

## Automatic test
## Automatic testing

To run the CI of RKeOps
```bash
bash run_ci.sh
```

> **Note 1**: this script creates a file `${HOME}/.R/Makevars` to add options to R compilation engine (it backs up any pre-existing version of the file and restore it afterwards).
To enable automatic tests to be run on GPU, the environment variable `TEST_GPU` should be defined with the value `1` before running the CI scripts, i.e.
```bash
export TEST_GPU=1
Expand Down Expand Up @@ -45,3 +43,16 @@ Rscript run_check.R
```

> **Note:** you should run `Rscript prepare_ci.R` before calling `run_tests.R` or `run_check.R` to install dependencies.
## Webpage generation

The RKeOps package webpage is generated with [`pkgdown`](https://pkgdown.r-lib.org/).

You should be able to generate it with:

```bash
cd rkeops/ci
bash build_website.sh
cd ../..
cp -r rkeops/docs/ WEBSITE_ROOT_DIR/rkeops/
```
11 changes: 10 additions & 1 deletion rkeops/recipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,19 @@ should be defined with the value `1` before running the CI scripts, i.e.
export TEST_GPU=1
```

## Documentation and website integration
## Documentation and webpage generation

The RKeOps package webpage is generated with [`pkgdown`](https://pkgdown.r-lib.org/).

You should be able to generate it with:

```bash
cd rkeops/ci
bash build_website.sh
cd ../..
cp -r rkeops/docs/ WEBSITE_ROOT_DIR/rkeops/
```

### Legacy doc (version <2)

To generate html files from the vignettes that can be integrated into the
Expand Down

0 comments on commit e2eaa9b

Please sign in to comment.