Use articles

iiasa · Feb 22, 2023 · dc50158 · dc50158
1 parent e67af37
commit dc50158
Show file tree

Hide file tree

Showing 262 changed files with 88 additions and 31,972 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -24,3 +24,5 @@ configure.ac
 LICENSE.md
 README.Rmd
 ^CITATION\.cff$
+^vignettes/articles$
+CONTRIBUTING.md
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -2,7 +2,7 @@
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   pull_request:
-    branches: [main, master]
+    branches: [master, dev]
   release:
     types: [published]
   workflow_dispatch:

diff --git a/.gitignore b/.gitignore
@@ -64,4 +64,4 @@ src/*.dll
 # Other temporary files
 tmp/
 tmp/*.*
-docs
+inst/doc
diff --git a/vignettes/contributing.Rmd → CONTRIBUTING.md b/vignettes/contributing.Rmd → CONTRIBUTING.md
@@ -1,22 +1,11 @@
----
-title: "Contributing"
-author: "Martin Jung"
-date: "`r Sys.Date()`"
-output: rmarkdown::html_vignette
-vignette: >
-  %\VignetteIndexEntry{Contributing}
-  %\VignetteEngine{knitr::rmarkdown}
-  %\VignetteEncoding{UTF-8}
----
-
 # Contributing to development of the  _ibis.iSDM_ R-package
 
-We welcome contributions to the _ibis.iSDM_ R-package. These contributions could be simple typo fixes, additions to the documentation and **testthat** tests, enhancing the vignettes to provide a greater understanding this package, or completely new functions. 
+We welcome contributions to the _ibis.iSDM_ R-package. These contributions could be simple typo fixes, additions to the documentation and **testthat** tests, enhancing the vignettes to provide a greater understanding this package, or completely new functions.
 
 For the latter, please get in touch with the package authors first.
 
-*Note that pushing to master or forking is disabled at the moment.* 
-This will be changed in the future when the package has reached a stable state. Pull requests require a confirmation and review from active editors. 
+*Note that pushing to master or forking is disabled at the moment.*
+This will be changed in the future when the package has reached a stable state. Pull requests require a confirmation and review from active editors.
 
 ### Development guidelines
 

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -49,7 +49,9 @@ Suggests:
     doParallel,
     rstan (>= 2.21.0),
     rstantools (>= 2.1.1),
-    BoomSpikeSlab (>= 1.2.4)
+    BoomSpikeSlab (>= 1.2.4),
+    rmarkdown,
+    knitr
 URL: https://iiasa.github.io/ibis.iSDM/
 BugReports: https://github.com/iiasa/ibis.iSDM/issues
 RoxygenNote: 7.2.3
@@ -125,3 +127,4 @@ Collate:
 Roxygen: list(markdown = TRUE)
 Biarch: true
 SystemRequirements: GNU make
+VignetteBuilder: knitr
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -45,10 +45,10 @@ navbar:
           href: articles/05_package_comparison.html
     faq:
       text: FAQ
-      href: articles/frequently-asked-questions.html
+      href: articles/06_frequently-asked-questions.html
     contributing:
       text: Contributing
-      href: articles/contributing.html
+      href: contributing/index.html
 
 reference:
   - title: Setting up and train models

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/404.html b/docs/404.html
-Original file line number
+Diff line change
@@ Expand Up / @@ -64,4 +64,4 @@ src/*.dll @@
     # Other temporary files
     tmp/
     tmp/*.*
-    docs
+    inst/doc