Skip to content

prebuilt documentation in docs folder - package site? #4

@shannonhaughton

Description

@shannonhaughton

the r packages book says you shouldn't store the prebuilt documentation in the docs folder, this will be removed when you run the cmd check locally. I don't think the vignettes command you've put in the readme will necessarily work for the GitHub version of the package.

Image

https://r-pkgs.org/vignettes.html#sec-vignettes-how-built

Image

They recommend you set up a GitHub pages site for your vignettes instead if you want it available for viewing on the GitHub version

https://github.com/GSK-Biostatistics/hassediagram/blob/e78a8e7f910b4b121305df86f294f00d7dc37739/inst/doc/Introduction_to_hassediagram.html#L1

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions