Utilities

#Documenter.Utilities — Module.

Provides a collection of utility functions and types that are used in other submodules.

source

#Documenter.Utilities.Object — Type.

Represents an object stored in the docsystem by its binding and signature.

source

#Documenter.Utilities.assetsdir — Method.

Returns the path to the Documenter assets directory.

source

#Documenter.Utilities.check_kwargs — Method.

Prints a formatted warning to the user listing unrecognised keyword arguments.

source

#Documenter.Utilities.currentdir — Method.

Returns the current directory.

source

#Documenter.Utilities.doccat — Method.

Returns the category name of the provided Object.

source

#Documenter.Utilities.docs — Function.

docs(ex, str)

Returns an expression that, when evaluated, returns the docstrings associated with ex.

source

#Documenter.Utilities.filterdocs — Method.

filterdocs(doc, modules)

Remove docstrings from the markdown object, doc, that are not from one of modules.

source

#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.

source

#Documenter.Utilities.log — Method.

Format and print a message to the user.

source

#Documenter.Utilities.logging — Method.

logging(flag::Bool)

Enable or disable logging output for log and warn.

source

#Documenter.Utilities.nodocs — Method.

Does the given docstring represent actual documentation or a no docs error message?

source

#Documenter.Utilities.object — Method.

object(ex, str)

Returns a expression that, when evaluated, returns an Object representing ex.

source

#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.

source

#Documenter.Utilities.slugify — Method.

Slugify a string into a suitable URL.

source

#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).

source

#Documenter.Utilities.submodules — Method.

Returns the set of submodules of a given root module/s.

source

#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.

source

#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 function f.
  • success signals whether f has thrown an error, in which case result stores the Exception that was raised.
  • backtrace a Vector{Ptr{Void}} produced by catch_backtrace() if an error is thrown.
  • output is the combined output of STDOUT and STDERR during execution of f.

source