Utilities
#Documenter.Utilities
— Module.
Provides a collection of utility functions and types that are used in other submodules.
#Documenter.Utilities.Object
— Type.
Represents an object stored in the docsystem by its binding and signature.
#Documenter.Utilities.assetsdir
— Method.
Returns the path to the Documenter assets
directory.
#Documenter.Utilities.check_kwargs
— Method.
Prints a formatted warning to the user listing unrecognised keyword arguments.
#Documenter.Utilities.currentdir
— Method.
Returns the current directory.
#Documenter.Utilities.doccat
— Method.
Returns the category name of the provided Object
.
#Documenter.Utilities.docs
— Function.
docs(ex, str)
Returns an expression that, when evaluated, returns the docstrings associated with ex
.
#Documenter.Utilities.filterdocs
— Method.
filterdocs(doc, modules)
Remove docstrings from the markdown object, doc
, that are not from one of modules
.
#Documenter.Utilities.issubmodule
— Method.
issubmodule(sub, mod)
Checks whether sub
is a submodule of mod
. A module is also considered to be its own submodule.
E.g. A.B.C
is a submodule of A
, A.B
and A.B.C
, but it is not a submodule of D
, A.D
nor A.B.C.D
.
#Documenter.Utilities.log
— Method.
Format and print a message to the user.
#Documenter.Utilities.logging
— Method.
logging(flag::Bool)
Enable or disable logging output for log
and warn
.
#Documenter.Utilities.nodocs
— Method.
Does the given docstring represent actual documentation or a no docs error message?
#Documenter.Utilities.object
— Method.
object(ex, str)
Returns a expression that, when evaluated, returns an Object
representing ex
.
#Documenter.Utilities.parseblock
— Method.
Returns a vector of parsed expressions and their corresponding raw strings.
The keyword argument skip = N
drops the leading N
lines from the input string.
#Documenter.Utilities.slugify
— Method.
Slugify a string into a suitable URL.
#Documenter.Utilities.srcpath
— Method.
Find the path of a file relative to the source
directory. root
is the path to the directory containing the file file
.
It is meant to be used with walkdir(source)
.
#Documenter.Utilities.submodules
— Method.
Returns the set of submodules of a given root module/s.
#Documenter.Utilities.warn
— Method.
warn(file, msg) warn(msg)
Format and print a warning message to the user. Passing a file
will include the filename where the warning was raised.
#Documenter.Utilities.withoutput
— Method.
Call a function and capture all STDOUT
and STDERR
output.
withoutput(f) --> (result, success, backtrace, output)
where
result
is the value returned from calling functionf
.success
signals whetherf
has thrown an error, in which caseresult
stores theException
that was raised.backtrace
aVector{Ptr{Void}}
produced bycatch_backtrace()
if an error is thrown.output
is the combined output ofSTDOUT
andSTDERR
during execution off
.