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.get_commit_short
— Method.get_commit_short(dir)
Returns the first 5 characters of the current git commit hash of the directory dir
.
Documenter.Utilities.isabsurl
— Method.isabsurl(url)
Checks whether url
is an absolute URL (as opposed to a relative one).
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.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.
Returns a Vector
of tuples (expr, code)
, where expr
is the corresponding expression (e.g. a Expr
or Symbol
object) and code
is the string of code the expression was parsed from.
The keyword argument skip = N
drops the leading N
lines from the input string.
relpath_from_repo_root(file)
Returns the path of file
, relative to the root of the Git repository, or nothing
if the file is not in a Git repository.
Documenter.Utilities.repo_root
— Method.repo_root(file; dbdir=".git")
Tries to determine the root directory of the repository containing file
. If the file is not in a repository, the function returns nothing
.
The dbdir
keyword argument specifies the name of the directory we are searching for to determine if this is a repostory or not. If there is a file called dbdir
, then it's contents is checked under the assumption that it is a Git worktree.
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{Cvoid}}
produced bycatch_backtrace()
if an error is thrown.output
is the combined output ofstdout
andstderr
during execution off
.