1#![doc = include_str!("../README.md")]
2#![warn(missing_docs)]
3
4mod bounded;
5mod catalog;
6mod executable;
7mod loading;
8mod manual;
9#[cfg(feature = "roff")]
10mod manual_input;
11mod manual_paths;
12mod scope_load;
13mod source;
14mod tldr;
15
16pub use catalog::{
17 AvailableDocument, AvailableDocumentKind, AvailableDocumentOrigin, CatalogError,
18 PreparedCatalogQuery, discover_documents, list_available_documents, query_available_documents,
19};
20pub use executable::{ExecutableLookup, find_host_executable};
21#[cfg(feature = "roff")]
22pub use loading::load_roff_bytes;
23pub use loading::{
24 DocumentLoader, LoadError, LoadPolicy, LoadSpec, MAX_MARKDOWN_BYTES, ManualLoadError,
25 load_markdown_text, validate_load_spec,
26};
27pub use mant_ir::{ResolvedContent, is_manual_section};
28pub use manual::{is_command_manual_section, parenthesized_manual_reference};
29#[cfg(feature = "roff")]
30pub use manual_input::{
31 MAX_MANUAL_BYTES, ManualError, ManualErrorKind, parse_manual_bytes, parse_manual_page,
32 parse_manual_source, parse_manual_source_with_report,
33};
34pub use manual_paths::{
35 ManualPathDiagnostic, ManualRootDiscovery, discover_manual_roots, inspect_manual_roots,
36};
37pub use scope_load::{LoadedDocumentScope, ScopeLoadError, validate_document_scope};
38pub use source::{LocateError, ManualIndex, ManualPage, ManualRequest, locate_manual_source_in};
39pub use tldr::{
40 HostPlatform, TldrCacheError, get_system_tldr_cache_dirs, get_tldr_cache_dir,
41 get_tldr_languages, get_tldr_platforms, get_tldr_read_cache_dirs, normalize_tldr_topic,
42 read_cached_tldr_page,
43};