DocumenterTools

DocumenterTools

package_devpath(pkg)

Returns the path to the top level directory of a devved out package source tree. The package is identified by its top level module pkg.

Generator

Provides the functions related to generating documentation stubs.

gitignore()

Contents of the default .gitignore file.

index(pkgname)

Contents of the default src/index.md file.

make(pkgname; format)

Contents of the default make.jl file.

mkdocs(pkgname; description, author, url)

Contents of the default mkdocs.yml file.

project(; format)

Contents of the default Project.toml file.

savefile(f, root, filename)

Attempts to save a file at $(root)/$(filename). f will be called with file stream (see open).

filename can also be a file in a subdirectory (e.g. src/index.md), and then then subdirectories will be created automatically.