altdoc 0.3.0 (#256)

* bump version

* fix URLs

* update wordlist

* NEWS.Rd in buildignore

* fix test

* update snapshots with latest quarto stable

* fix test and NOTE

* cleanup docs

* use proper vignette preamble

* update cran comments

* do not put vignettes in buildignore

* description shouldn't start with pkg name

* use full link to "get started"

* add cran comments

.Rbuildignore

@@ -12,6 +12,6 @@
 ^CRAN-SUBMISSION$
 ^docs$
 ^altdoc$
-^vignettes$
 ^.lintr$
-man-roxygen
+man-roxygen
+^inst/NEWS\.Rd$

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: altdoc
 Title: Package Documentation Websites with 'Quarto', 'Docsify', 'Docute', or 'MkDocs'
-Version: 0.2.2.9014
+Version: 0.3.0
 Authors@R: 
     c(person(given = "Etienne",
              family = "Bacher",
@@ -13,7 +13,10 @@ Authors@R:
              email = "[email protected]",
              comment = c(ORCID = "0000-0003-2042-7063"))
     )
-Description: 'altdoc' is a simple and powerful package to create, render, preview, and deploy documentation websites for 'R' packages. It is a lightweight and flexible alternative to 'pkgdown', with support for many documentation generators, including 'Quarto', 'Docute', 'Docsify', and 'MkDocs'.
+Description: This is a simple and powerful package to create, render, preview, 
+    and deploy documentation websites for 'R' packages. It is a lightweight and 
+    flexible alternative to 'pkgdown', with support for many documentation 
+    generators, including 'Quarto', 'Docute', 'Docsify', and 'MkDocs'.
 License: MIT + file LICENSE
 URL: https://altdoc.etiennebacher.com, https://github.com/etiennebacher/altdoc
 BugReports: https://github.com/etiennebacher/altdoc/issues
@@ -40,6 +43,6 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3.9000
+RoxygenNote: 7.3.1
 Language: en-US
 VignetteBuilder: knitr

NEWS.md

@@ -1,37 +1,67 @@
 # News
 
-## (development version)
+## 0.3.0
 
-Breaking changes:
+All functions have changed so any change listed below technically is a breaking 
+change.
+
+### Breaking changes
 
 * Functions renamed:
   - `use_docute()`, `use_docsify()` and `use_mkdocs()` are combined into `setup_docs()` 
   - `update_docs()` -> `render_docs()`
   - `preview()` -> `preview_docs()`
-* `setup_docs()` (previously `use_*()`) no longer updates and previews the website by default.
-* `custom_reference` argument is removed. See the `Post-processing` vignette for a description of the new proposed workflow.
-* `theme` argument is removed. Users can change themes by editing settings files in `altdoc/`
+
+* `setup_docs()` (previously `use_*()`) no longer updates and previews the website 
+  by default.
+* `custom_reference` argument is removed. See the `Post-processing` vignette for 
+  a description of the new proposed workflow.
+* `theme` argument is removed. Users can change themes by editing settings files 
+  in `altdoc/`
 * `mkdocs` documentation is no longer stored in `docs/docs/`
 
-New:
+### New features
 
 * Support Quarto websites as a documentation format.
+
 * Support Quarto vignettes (.qmd) in the `vignettes/` folder.
-* `render_docs(parallel=TRUE)` uses `future` to parallelize the rendering of vignettes and man pages.
-* `render_docs(freeze = TRUE)` no longer renders vignettes or man pages when they have not changed and are already stored in `docs/`.
+
+* `render_docs(parallel = TRUE)` uses `future` to parallelize the rendering of 
+  vignettes and man pages.
+
+* `render_docs(freeze = TRUE)` no longer renders vignettes or man pages when they
+  have not changed and are already stored in `docs/`.
+
 * Link to source code at the top of function reference.
-* 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.
+
+* 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.
+
 * Improved vignettes
-* Do not reformat markdown header levels automatically, but raise a warning when there is more than one level 1 header.
+
+* Do not reformat markdown header levels automatically, but raise a warning when 
+  there is more than one level 1 header.
+
 * Fewer dependencies.
 * Fix parsing for issue/PR references like [org/repo#111].
+
 * Changelog and News sections can be present simultaneously.
+
 * Support for `NEWS.Rd`, either in the root folder or in `inst/`
+
 * Automatically create a Github Actions workflow with `setup_github_actions()`.
+
 * Skip .Rd files when they document internal functions.
 
+
 ## 0.2.2
 
 * If necessary, two spaces are automatically added in nested lists in the `NEWS` 

README.md

@@ -65,8 +65,9 @@ render_docs()
 preview_docs()
 ```
 
-See [the Get Started vignette](vignettes/get-started.md) for more
-details.
+See [the Get Started
+vignette](https://altdoc.etiennebacher.com/#/vignettes/get-started.md)
+for more details.
 
 ## Demos
 
@@ -154,10 +155,10 @@ Docsify
 <code>plot2</code>
 </td>
 <td>
-🌐<a href="https://grantmcdermott.com/plot2">grantmcdermott.com/plot2</a>
+🌐<a href="https://grantmcdermott.com/tinyplot/">grantmcdermott.com/tinyplot</a>
 </td>
 <td>
-<a href="https://github.com/grantmcdermott/plot2/tree/main/altdoc">Altdoc
+<a href="https://github.com/grantmcdermott/tinyplot/tree/main/altdoc">Altdoc
 Settings</a>
 </td>
 </tr>
@@ -184,7 +185,7 @@ Docsify
 <code>countrycode</code>
 </td>
 <td>
-🌐<a href="https://vincentarelbundock.github.io/countrycode">vincentarelbundock.github.io/countrycode</a>
+🌐<a href="https://vincentarelbundock.github.io/countrycode/">vincentarelbundock.github.io/countrycode</a>
 </td>
 <td>
 <a href="https://github.com/vincentarelbundock/countrycode/tree/main/altdoc">Altdoc
@@ -199,7 +200,7 @@ Docsify
 <code>WDI</code>
 </td>
 <td>
-🌐<a href="https://vincentarelbundock.github.io/WDI">vincentarelbundock.github.io/WDI</a>
+🌐<a href="https://vincentarelbundock.github.io/WDI/">vincentarelbundock.github.io/WDI</a>
 </td>
 <td>
 <a href="https://github.com/vincentarelbundock/WDI/tree/main/altdoc">Altdoc

README.qmd

@@ -64,7 +64,8 @@ render_docs()
 preview_docs()
 ```
 
-See [the Get Started vignette](vignettes/get-started.md) for more details.
+See [the Get Started vignette](https://altdoc.etiennebacher.com/#/vignettes/get-started.md)
+for more details.
 
 ## Demos
 
@@ -104,8 +105,8 @@ The websites in this table were created using Altdoc:
   <tr>
     <td>Docsify</td>
     <td><code>plot2</code></td>
-    <td>🌐<a href="https://grantmcdermott.com/plot2">grantmcdermott.com/plot2</a></td>
-    <td><a href="https://github.com/grantmcdermott/plot2/tree/main/altdoc">Altdoc Settings</a></td>
+    <td>🌐<a href="https://grantmcdermott.com/tinyplot/">grantmcdermott.com/tinyplot</a></td>
+    <td><a href="https://github.com/grantmcdermott/tinyplot/tree/main/altdoc">Altdoc Settings</a></td>
   </tr>
   <tr>
     <td>Docsify</td>
@@ -116,13 +117,13 @@ The websites in this table were created using Altdoc:
   <tr>
     <td>Docsify</td>
     <td><code>countrycode</code></td>
-    <td>🌐<a href="https://vincentarelbundock.github.io/countrycode">vincentarelbundock.github.io/countrycode</a></td>
+    <td>🌐<a href="https://vincentarelbundock.github.io/countrycode/">vincentarelbundock.github.io/countrycode</a></td>
     <td><a href="https://github.com/vincentarelbundock/countrycode/tree/main/altdoc">Altdoc Settings</a></td>
   </tr>
   <tr>
     <td>Docsify</td>
     <td><code>WDI</code></td>
-    <td>🌐<a href="https://vincentarelbundock.github.io/WDI">vincentarelbundock.github.io/WDI</a></td>
+    <td>🌐<a href="https://vincentarelbundock.github.io/WDI/">vincentarelbundock.github.io/WDI</a></td>
     <td><a href="https://github.com/vincentarelbundock/WDI/tree/main/altdoc">Altdoc Settings</a></td>
   </tr>
 </table>

cran-comments.md

@@ -2,5 +2,5 @@
 
 0 errors | 0 warnings | 0 note
 
-
-Resubmission to fix test failures on CRAN due to the new version of `usethis`.
+This is the second submission of altdoc 0.3.0 (first one was an hour ago). I 
+corrected the NOTEs reported.

inst/WORDLIST

@@ -30,3 +30,4 @@ Rmarkdown
 Rmd
 RStudio
 yaml
+venv