Generator
#Documenter.Generator
— Module.
Provides the functions related to generating documentation stubs.
#Documenter.Generator.gitignore
— Method.
Signatures
gitignore()
Contents of the default .gitignore
file.
#Documenter.Generator.index
— Method.
Signatures
index(pkgname)
Contents of the default src/index.md
file.
#Documenter.Generator.make
— Method.
Signatures
make(pkgname)
Contents of the default make.jl
file.
#Documenter.Generator.mkdocs
— Method.
Signatures
mkdocs(pkgname; description, author, url)
Contents of the default mkdocs.yml
file.
#Documenter.Generator.savefile
— Method.
Signatures
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.