fyi_cache

Ensure Package Docs Exist in Cache

Description

Generates fyi.md and man-md/ docs for any installed package into a central cache (~/.fyi//). Use this for all packages to keep documentation in a uniform location.

Usage

fyi_cache(
  package,
  force = FALSE,
  pattern = NULL,
  max_exports = NULL,
  max_internals = NULL,
  max_topics = NULL,
  internals = TRUE,
  docs_pattern = pattern,
  format = "default"
)

Arguments

package: Character. Package name.
force: Logical. Regenerate even if docs exist? Default FALSE.
pattern: Optional regex to filter exports/internals/topics in fyi.md, and which doc files to generate in man-md/.
max_exports: Maximum exports in fyi.md. Default NULL (all).
max_internals: Maximum internals in fyi.md. Use 0 to skip. Default NULL.
max_topics: Maximum doc topics to list in fyi.md. Default NULL (all).
internals: Include internal functions in fyi.md? Default TRUE.
docs_pattern: Optional separate pattern for man-md/ files (if different from fyi.md pattern).
format: Output format: “default” (HTML comments) or “hugo” (YAML front matter).

Value

Path to the package’s fyi directory, invisibly.

Examples

# Cache all docs for a small package
fyi_cache("sttapi")

# For large packages, filter to reduce fyi.md size
# (man-md/ files still generated for on-demand reading)
fyi_cache("torch",
          max_exports = 100,
          max_internals = 0,
          max_topics = 100)

# Only cache nn_* modules
fyi_cache("torch", pattern = "^nn_")

# Filter fyi.md but generate all doc files
fyi_cache("torch",
          pattern = "^nn_",
          docs_pattern = NULL)  # NULL = all docs

# Force regeneration
fyi_cache("torch", force = TRUE)

# Hugo format for static sites
fyi_cache("sttapi", format = "hugo")