Skip to content

Links to other helps documents in child docs #1637

@jonthegeek

Description

@jonthegeek

I'm trying to use child documents in help documentation, per this roxygen2 vignette and the reference in rpkgs 2e. However, I can't get it to work as described.

This example will link to the supplied URLs in HTML / Markdown files and it will link to the roxygenize help topic in the manual.

In my tests, it always links to the website, including when used in (local) documentation. See for example this doc generated from this roxygen2 header.

Specific use case: We have a number of reused parameters that we want to define the same way throughout the docs, and to define that way in vignettes and other articles. I'm trying to create definition Rmds for each term, which will be reused as needed.

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