Docile.Utilities

Methods [Exported]


parsefile(file::AbstractString)

Retrieve the Expr object from a Julia source file file.

Caches the expression based on it's file name and mtime value.

source: Docile/src/Utilities.jl:57

Methods [Internal]


init_cache()

Check cache directory for up to date version directory. Remove older version directories if any are found. Should be called on module initialisation.

source: Docile/src/Utilities.jl:30


init_cache(cache)

Check cache directory for up to date version directory. Remove older version directories if any are found. Should be called on module initialisation.

source: Docile/src/Utilities.jl:30


init_cache(cache, current)

Check cache directory for up to date version directory. Remove older version directories if any are found. Should be called on module initialisation.

source: Docile/src/Utilities.jl:30


expandpath(path)

Convert a path to absolute. Relative paths are guessed to be from Julia /base.

source: Docile/src/Utilities.jl:107


message(msg::AbstractString)

Print a 'Docile'-formatted message to STDOUT.

source: Docile/src/Utilities.jl:87


path_id(file::AbstractString)

Returns the cache path for a given file file.

source: Docile/src/Utilities.jl:46


samemodule(mod, def::Method)

Is the module where a function/method is defined the same as mod?

source: Docile/src/Utilities.jl:92

Globals [Internal]


BASE

Path to Julia's base source code.

source: Docile/src/Utilities.jl:102


CACHE_CUR

The current versioned cache subdirectory set by CACHE_VER

source: Docile/src/Utilities.jl:24


CACHE_DIR

Path to Docile's main cache folder.

source: Docile/src/Utilities.jl:21


CACHE_VER

Internal version of the cache structure.

source: Docile/src/Utilities.jl:18