Skip to content

altdoc 0.2.0

Compare
Choose a tag to compare
@etiennebacher etiennebacher released this 30 May 20:16
· 190 commits to main since this release

Breaking changes

  • Vignettes are no longer automatically added to the file that defines the structure
    of the website. Developers must now manually update this structure and the order
    of their articles.

Major changes

  • update_docs() now updates the package version as well as altdoc version in
    the footer.

  • The NEWS or Changelog file included in the docs now automatically links issues,
    pull requests and users (only works for projects on Github).

  • Vignettes are now always rendered by use_*() or update_docs(). Therefore,
    the argument convert_vignettes is removed. Previously, they were only rendered
    if their content changed. This was problematic because the code in a vignette
    can have different output while the vignette in itself doesn't change (#37, #38).

  • New argument custom_reference in use_*() and update_docs(). If it is a
    path to a custom R file then it uses this file to build the "Reference" section
    in the docs (#35).

Minor changes

  • Fix some CRAN failures.