DocumentationGenerator.dependencies_per_package
— Functiondependencies_per_package(registry=joinpath(homedir(), ".julia/registries/General"))
Find all declared (direct) dependencies for each package in registry
.
DocumentationGenerator.doctype
— Methoddoctype(packagespec, registry)
Gets the doctype for package packagespec
from the Registry.toml
at registry
. Returns a tuple of (doctype, uri)
, where doctype
can be
vendored
– Source code for the docs is located in the package directory. Default.git-repo
– Source code for the docs is located in the git-repo aturi
.hosted
– Built docs are available aturi
. We won't attempt to build/host them ourselves.
DocumentationGenerator.fix_makefile
— Functionfix_makefile(makefile)
Takes in the path to a Documenter.jl-compatible make.jl
file and
- Removes all calls to
deploydocs
. - Records the custom
build
kwarg in themakedocs
call. - Makes sure that
format
is set toDocumenter.HTML(...)
in themakedocs
call.
Return a tuple of new_make_expr, buildpath
.
DocumentationGenerator.get_registry
— Methodget_registry(basepath; registry=DOCS_REGISTRY, sync = true)
Clone the DocumentationGenerator registry into basepath
. No download will occur if sync == false
and the registry already exists.
Returns the path to the Registry.toml
(or nothing
if an error occured).
DocumentationGenerator.run_with_timeout
— Methodrun_with_timeout(
command; log=stdout, timeout = 5*60, name = "",
wait_time = 1, verbose = true
)
Runs command
and pipes all output to log
. The process will be terminated after timeout
seconds without any output. name
describes the process in log messages, and verbose
determines whether meta-logs ("process started" etc.) will be printed.