gleamoire/docs
Functions
pub fn get_docs(
interface: Package,
module_path: List(String),
item: Option(String),
print_mode: PrintMode,
) -> Result(String, Error)Main entrypoint for docs retrival
pub fn get_remote_interface(
package: String,
version: Option(Version),
) -> Result(String, Error)Pull docs from Hex
pub fn package_interface(
query: ParsedQuery,
cache_path: Option(String),
version: Option(Version),
refresh_cache: Bool,
) -> Result(Package, Error)Main package interface resolution entrypoint This is where we handle shorthands for gleam packages and edge cases
pub fn parse_interface(json: String) -> Result(Package, Error)Parse a JSON string into a package_interface.Package