DocumentationFiles

function defined in module Pollen


			DocumentationFiles(modules; kwargs) <: Rewriter

A Rewriter that finds written documentation like .md files in the package directories of modules and adds them to a [ Project]'s.

It finds all files in the directories dir = pkgdir(m ∈ modules). Then, if the file's extension matches one of extensions, a document with ID "(pkgname)"@(pkgversion)/(filepath) is created.

Also handles watching and reloading files in development mode.

Keyword arguments

  • extensions = ["md", "ipynb"]: File extensions to include

  • pkgtags = Dict(): Overwrite package versions

Methods

There are 2 methods for Pollen.DocumentationFiles: