fix: Prefer README.md over README.qmd in Quarto websites too (#354)

Author: etiennebacher

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: altdoc
 Title: Package Documentation Websites with 'Quarto', 'Docsify', 'Docute', or 'MkDocs'
-Version: 0.7.0
+Version: 0.7.0.9000
 Authors@R:
     c(person(given = "Etienne",
              family = "Bacher",

NEWS.md

@@ -1,5 +1,16 @@
 # News
 
+## Development version
+
+### Bug fixes
+
+* In 0.5.0, we announced that `README.qmd` wouldn't be automatically rendered,
+  but this still happened when `output = "quarto_website"`. This is now fixed,
+  meaning that `altdoc` uses `README.md` over `README.qmd` (#354).
+
+* Figures stored in `man/figures` and used in the README are now properly
+  displayed (#354).
+
 ## 0.7.0
 
 ### New features

R/import_man.R

@@ -37,7 +37,10 @@
                 fs::path_join(c(tar_dir, "help", "figures")),
                 overwrite = TRUE
             )
-            fs::dir_delete(fs::path_join(c(b, "figures")))
+            # We used to delete the old "fs::path_join(c(b, "figures"))", but
+            # this prevented images in README to be displayed when they were
+            # stored in "man/figures". The README is never passed to Rd2HTML(),
+            # so the paths to the figures were never updated to "../help/figures".
         }
     }
 

R/import_readme.R

@@ -60,7 +60,9 @@
 
     # Add the index page which includes README.md
     if (tool == "quarto_website") {
-        if ("README.qmd" %in% readme_files) {
+        if (
+            "README.qmd" %in% readme_files && !("README.md" %in% readme_files)
+        ) {
             fs::file_copy(
                 fs::path_join(c(src_dir, "README.qmd")),
                 fs::path_join(c(tar_dir, "index.qmd"))

tests/testthat/_snaps/docsify/render_docs/index.html

@@ -28,7 +28,7 @@
       },
       plugins: [
         function(hook) {
-          var footer = ["<a > <code> testpkg.altdoc </code> v. 0.1.0 </a> | Documentation made with <a href='https://altdoc.etiennebacher.com/'> <code> altdoc </code> v. 0.7.0</a>"].join('');
+          var footer = ["<a > <code> testpkg.altdoc </code> v. 0.1.0 </a> | Documentation made with <a href='https://altdoc.etiennebacher.com/'> <code> altdoc </code> v. 0.7.0.9000</a>"].join('');
 
           hook.afterEach(function(html) {
             return html + footer;

tests/testthat/test-render_docs.R

@@ -342,6 +342,24 @@ theme:
     )))
 })
 
+test_that("quarto_website: ensure that README.md is preferred over README.qmd", {
+    skip_on_cran()
+    skip_if(.is_windows() && .on_ci(), "Windows on CI")
+    skip_if(!.quarto_is_installed())
+
+    create_local_package()
+
+    cat("hello there", file = "README.md")
+    cat("---hello there\nhello again", file = "README.qmd")
+    setup_docs("quarto_website")
+    render_docs(verbose = .on_ci())
+    expect_false(any(grepl(
+        "hello again",
+        .readlines("docs/index.html"),
+        fixed = TRUE
+    )))
+})
+
 test_that(".add_pkgdown() works", {
     skip_on_cran()
     skip_if(.is_windows() && .on_ci(), "Windows on CI")