DocChecks
Documenter.DocChecks
— ModuleProvides the missingdocs
, footnotes
and linkcheck
functions for checking docs.
Documenter.DocChecks.footnotes
— Methodfootnotes(doc)
Checks footnote links in a Documenter.Document
.
Documenter.DocChecks.linkcheck
— Methodlinkcheck(doc)
Checks external links using curl.
Documenter.DocChecks.missingdocs
— Methodmissingdocs(doc)
Checks that a Documenter.Document
contains all available docstrings that are defined in the modules
keyword passed to Documenter.makedocs
.
Prints out the name of each object that has not had its docs spliced into the document.
Returns the number of missing bindings to allow for automated testing of documentation.