samatha (version 0.41)

doc.index.list: Produces an unordered list of links to rendered documentation files

Description

Produces an unordered list of links to rendered documentation files

Usage

doc.index.list(doc.pages, out.path)

Arguments

doc.pages

a list of Samatha.Page objects, as produced by render.all.docs()

out.path

path to documents relative to the Samatha site

Value

character string representation of an unorderd list of links to rendered documentation files