Skip to main content

resolve_docs_dir

Function resolve_docs_dir 

Source
pub fn resolve_docs_dir(start_path: &Path) -> Option<PathBuf>
Expand description

Resolve the docs_dir for a project by finding and parsing mkdocs.yml.

Results are cached by the canonicalized mkdocs.yml path to avoid repeated filesystem operations and YAML parsing.

start_path should be the markdown file being checked or its parent directory. Returns the absolute path to the docs directory, or None if no mkdocs.yml is found.