Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rempsyc committed Oct 28, 2023
1 parent 13a10e7 commit 36a4703
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 1 deletion.
5 changes: 4 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@

* 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.
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
Expand Down
8 changes: 8 additions & 0 deletions R/use.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@
#'
#' @return No value returned. Creates files in folder 'docs'. Other files and
#' folders are not modified.
#'
#' Note that 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. The name of the file defining
#' the structure of the website lives at the root of `/docs` and differs based
#' on the selected site builder (`use_docsify()` = `_sidebar.md`;
#' `use_docute()` = `index.html`; `use_mkdocs()` = `mkdocs.yml`).
#'
#' @rdname init
#'
#' @examples
Expand Down
1 change: 1 addition & 0 deletions altdoc.Rproj
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ StripTrailingWhitespace: Yes
BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageRoxygenize: rd,collate,namespace
7 changes: 7 additions & 0 deletions man/init.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 36a4703

Please sign in to comment.