Skip to content

altdoc 0.4.0

Latest
Compare
Choose a tag to compare
@etiennebacher etiennebacher released this 23 Jul 21:16

Breaking changes

  • Simplified rendering for Quarto websites. Previously, the website was rendered
    into _quarto/_site and manually copied over to docs/. The new version removes
    this logic and instead uses the output-dir project option. To transition, change
    quarto_website.yml to:
    project:
      output-dir: ../docs/

New features

  • render_docs(freeze = TRUE) now works correctly when output is "quarto_website".
    Freezing a document needs to be set either at a project or per-file level. To do
    so, add to either quarto_website.yml or the frontmatter of a file:

    execute:
      freeze: auto
  • For Quarto websites, render_docs() can use the downlit package to automatically
    link function calls to their documentation on the web. Turn off by modifying
    the code-link line in altdoc/quarto_website.yml

  • Citation is now formatted with HTML instead of verbatim (#282, Achim Zeileis).

  • The \doi{} tags in Rd files are now linked once rendered (#282, Achim Zeileis).

  • Warn if README.qmd does not exist when calling setup_docs("quarto_website"). Issue #280.

Other changes

  • Update github-pages-deploy-action to v4
  • Support @examplesIf tag in roxygen2