DocSeeker.alldocs
— Functionalldocs(topmod = Main) -> Vector{DocObj}
Find all docstrings in all currently loaded Modules.
DocSeeker.baseURL
— MethodbaseURL(links::Vector{Markdown.Link}) -> String
Find the most common host and return the first URL in links
with that host.
DocSeeker.createdocsdb
— Methodcreatedocsdb()
Asynchronously create a "database" of all local docstrings in Pkg.installed()
. This is done by loading all packages and using introspection to retrieve the docstrings – the obvious limitation is that only packages that actually load without errors are considered.
DocSeeker.docsdir
— Methoddocsdir(pkg) -> String
Find the directory conataining the documenatation for package pkg
. Will fall back to returning a package's README.md. Returns an empty String
if no indication of documentation is found.
DocSeeker.docsurl
— Methoddocsurl(pkg) -> String
Return the most likely candidate for a package's online documentation or an empty string.
DocSeeker.finddocsURL
— MethodfinddocsURL(pkg) -> Vector{Markdown.Link}
Search pkg
s readme for links to documentation.
DocSeeker.loaddocsdb
— Methodloaddocsdb() -> Vector{DocObj}
Retrieve the docstrings from the "database" created by createdocsdb()
. Will return an empty vector if the database is locked by createdocsdb()
.
DocSeeker.score
— Functionscore(needle::AbstractString, s::DocObj, mod::String = "Main", name_only::Bool = false) -> Float
Scores s
against the search query needle
. Returns a Float
between 0 and 1.