GitHub

Documenter

Documenter.gitrm_copy — Function
gitrm_copy(src, dst)

Uses git rm -r to remove dst and then copies src to dst. Assumes that the working directory is within the git repository of dst is when the function is called.

This is to get around #507 on filesystems that are case-insensitive (e.g. on OS X, Windows). Without doing a git rm first, git add -A will not detect case changes in filenames.

source
Documenter.git_push — Function
git_push(
    root, tmp, repo;
    branch="gh-pages", dirname="", target="site", sha="", devurl="dev",
    deploy_config, folder,
)

Handles pushing changes to the remote documentation branch. The documentation are placed in the folder specified by subfolder.

source
Documenter.user_host_upstream — Function
user_host_upstream(repo)

Disassemble repo address into user, host, and path to repo. If no user is given, default to "git". Reassemble user, host and path into an upstream to git push to.

source
Documenter.find_object — Function
find_object(doc, binding, typesig)

Find the included Object in the doc matching binding and typesig. The matching heuristic isn't too picky about what matches and will only fail when no Bindings matching binding have been included.

source
Documenter.xrefname — Function

Parse the link.url field of an at-ref link. Returns nothing if it's not an at-ref, an empty string the reference link has no label, or a whitespace-stripped version the label.

source