Skip to content

NEWS.md

Latest commit

 

History

History
192 lines (124 loc) · 6.22 KB

NEWS.md

File metadata and controls

192 lines (124 loc) · 6.22 KB

News

development version

Changes

  • The CSS for arguments table in "Reference" page has changed a bit. Argument names are now wrapped so that they have limited width, improving the readibility in case of multiple arguments on the same line (#308).

  • Files stored in man/figures (such as lifecycle badges) are now properly included by render_docs() (#321).

  • render_docs() now renders to Github-flavored markdown (gfm) that seems to be used by all docs generators used by altdoc. This enables for instance a better support for footnotes (#332).

Bug fixes

  • Fix a quarto_website rendering failure when the package being rendered has its URL or BugReports set to a site other than GitHub (#319, @gardiners).

  • Fix footer in docsify when a package doesn't have a website or GitHub URL (#324).

  • render_docs() now shows an explicit error message if Quarto is not installed on the system (#329).

0.5.0

Breaking changes

  • Do not render README.qmd to markdown automatically. Users should render them manually to make sure that the README on CRAN and Github is in sync with the Altdoc home page.

Other changes

  • README.qmd is no longer required to create a quarto_website, only README.md (#295).

Bug fixes

  • Fix some failures in CRAN checks (#303).

0.4.0

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

0.3.0

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/

  • mkdocs documentation is no longer stored in docs/docs/

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/.

  • 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.

  • Improved vignettes

  • 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 (or Changelog) file.

  • This is the last release before a large rework of this package.

0.2.1

  • Fix test failures on CRAN due to the new version of usethis (see cynkra/fledge#683).

0.2.0

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. Note that the name of the file defining the structure of the website differs based on the selected site builder. This file lives at the root of /docs (use_docsify() = _sidebar.md; use_docute() = index.html; use_mkdocs() = mkdocs.yml).

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.

0.1.0

  • First version.