Skip to content

Commit

Permalink
chore: regen doc
Browse files Browse the repository at this point in the history
  • Loading branch information
salim-b committed Dec 14, 2024
1 parent b4bcee0 commit dd0f87e
Show file tree
Hide file tree
Showing 47 changed files with 140 additions and 107 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ remotes::install_gitlab(repo = "rpkg.dev/pkgpins")

### R Markdown format

This package’s source code is written in the [R Markdown](https://rmarkdown.rstudio.com/) file format to facilitate practices commonly referred to as [*literate programming*](https://en.wikipedia.org/wiki/Literate_programming). It allows the actual code to be freely mixed with explanatory and supplementary information in expressive Markdown format instead of having to rely on [`#` comments](https://cran.r-project.org/doc/manuals/r-release/R-lang.html#Comments) only.
This package’s source code is written in the [R Markdown](https://rmarkdown.rstudio.com/) file format to facilitate practices commonly referred to as [*literate programming*](https://en.wikipedia.org/wiki/Literate_programming). It allows the actual code to be freely mixed with explanatory and supplementary information in expressive Markdown format instead of having to rely on [`#` comments](https://rstudio.github.io/r-manuals/r-lang/Parser.html#comments) only.

All the `.gen.R` suffixed R source code found under [`R/`](https://gitlab.com/rpkg.dev/pkgpins/-/tree/master/R/) is generated from the respective R Markdown counterparts under [`Rmd/`](https://gitlab.com/rpkg.dev/pkgpins/-/tree/master/Rmd/) using [`pkgpurl::purl_rmd()`](https://pkgpurl.rpkg.dev/dev/reference/purl_rmd.html)[^2]. Always make changes only to the `.Rmd` files – never the `.R` files – and then run `pkgpurl::purl_rmd()` to regenerate the R source files.

Expand Down
4 changes: 2 additions & 2 deletions docs/dev/LICENSE.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 6 additions & 5 deletions docs/dev/TODO.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/dev/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/dev/deps/data-deps.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
<link href="deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet" />
<script src="deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script>
<link href="deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet" />
<link href="deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet" />
<link href="deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet" />
<link href="deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet" />
<script src="deps/headroom-0.11.0/headroom.min.js"></script>
<script src="deps/headroom-0.11.0/jQuery.headroom.min.js"></script>
<script src="deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script>
Expand Down
Loading

0 comments on commit dd0f87e

Please sign in to comment.