Add message after "Update HTML" (#101)

etiennebacher · Nov 20, 2023 · 3a4d5a6 · 3a4d5a6
1 parent 28b9669
commit 3a4d5a6
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 7 deletions.
diff --git a/R/settings.R b/R/settings.R
@@ -31,4 +31,6 @@
         .import_settings_mkdocs(path = path)
     }
 
+    cli::cli_alert_success("HTML updated.")
+
 }
diff --git a/docs/NEWS.md b/docs/NEWS.md
@@ -16,6 +16,7 @@ Breaking changes:
 New:
 
 * Support for Quarto vignettes (.qmd) stored in the `vignettes/` folder.
+* `render_docs(parallel=TRUE)` uses `future` to parallelize the rendering of vignettes and man pages.
 * Settings files are now permanently stored in the `altdoc/` directory. These files can be edited manually to customize the website.
 * Major internal changes to the .Rd -> .md conversion system. We now use Quarto to convert man pages and execute examples, and the man pages are stored in separate markdown files instead of combined in a single large file.
 * `mkdocs` now behaves like the other documentation generators and stores its files in `docs/`. This means that `mkdocs` websites can be deployed to Github Pages.

diff --git a/docs/index.html b/docs/index.html
@@ -41,7 +41,7 @@
           {title: 'Reference', children: [{title: 'preview_docs', link: '/man/preview_docs.md'}, {title: 'render_docs', link: '/man/render_docs.md'}, {title: 'setup_docs', link: '/man/setup_docs.md'}]},
 					{title: 'License', link: '/LICENSE'}
 				],
-        footer: "<a href='https://altdoc.etiennebacher.com'> <code> altdoc </code> v. 0.2.2.9006 </a> | Documentation made with <a href='https://altdoc.etiennebacher.com/'> <code> altdoc </code> v. 0.2.2.9006</a>"
+        footer: "<a href='https://altdoc.etiennebacher.com'> <code> altdoc </code> v. 0.2.2.9007 </a> | Documentation made with <a href='https://altdoc.etiennebacher.com/'> <code> altdoc </code> v. 0.2.2.9007</a>"
       })
     </script>
   </body>

diff --git a/...preview_docs.markdown_strict_files/figure-markdown_strict/unnamed-chunk-1-1.png b/...preview_docs.markdown_strict_files/figure-markdown_strict/unnamed-chunk-1-1.png
diff --git a/docs/man/preview_docs.md b/docs/man/preview_docs.md
@@ -41,4 +41,12 @@ if (interactive()) {
   preview_docs()
 
 }
+
+# This is an example to illustrate that code-generated images are properly
+# displayed. See the `altdoc` website for a rendered version.
+with(mtcars, plot(mpg, wt))
 ```
+
+<img
+src="preview_docs.markdown_strict_files/figure-markdown_strict/unnamed-chunk-1-1.png"
+id="fig-539a35d47e664c97a50115a146a7f1bd-1" />
diff --git a/.../get-started.markdown_strict_files/figure-markdown_strict/unnamed-chunk-1-1.png b/.../get-started.markdown_strict_files/figure-markdown_strict/unnamed-chunk-1-1.png
diff --git a/docs/vignettes/get-started.md b/docs/vignettes/get-started.md
@@ -184,6 +184,9 @@ images in Rmarkdown vignettes.
 with(mtcars, plot(mpg, wt))
 ```
 
-![](vignettes/get-started.markdown_strict_files/figure-markdown_strict/unnamed-chunk-1-1.png)
+<img
+src="get-started.markdown_strict_files/figure-markdown_strict/unnamed-chunk-1-1.png"
+id="fig-539a35d47e664c97a50115a146a7f1bd-1" />
 
-![](images/hex-conductor.png)
+<img src="images/hex-conductor.png"
+id="fig-539a35d47e664c97a50115a146a7f1bd-2" />
diff --git a/...ettes/themes.markdown_strict_files/figure-markdown_strict/unnamed-chunk-2-1.png b/...ettes/themes.markdown_strict_files/figure-markdown_strict/unnamed-chunk-2-1.png
diff --git a/docs/vignettes/themes.md b/docs/vignettes/themes.md
@@ -62,7 +62,8 @@ render_docs()
 
 Here is a preview of the result:
 
-![](images/themes_docsify_preview.png)
+<img src="images/themes_docsify_preview.png"
+id="fig-539a35d47e664c97a50115a146a7f1bd-1" />
 
 Click on Details to display the full HTML template:
 
@@ -182,7 +183,8 @@ render_docs()
 
 Here is a preview of the result:
 
-![](images/themes_mkdocs_preview.png)
+<img src="images/themes_mkdocs_preview.png"
+id="fig-539a35d47e664c97a50115a146a7f1bd-2" />
 
 ## Docute
 
@@ -202,6 +204,9 @@ images in Quarto vignettes.
 with(mtcars, plot(mpg, wt))
 ```
 
-![](vignettes/themes.markdown_strict_files/figure-markdown_strict/unnamed-chunk-2-1.png)
+<img
+src="themes.markdown_strict_files/figure-markdown_strict/unnamed-chunk-2-1.png"
+id="fig-539a35d47e664c97a50115a146a7f1bd-3" />
 
-![](images/hex-conductor.png)
+<img src="images/hex-conductor.png"
+id="fig-539a35d47e664c97a50115a146a7f1bd-4" />
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,4 +31,6 @@ @@
             .import_settings_mkdocs(path = path)
         }
+        cli::cli_alert_success("HTML updated.")
     }