Update docs (#106)
This commit is contained in:
@@ -13,6 +13,8 @@ while doc_dir.name != doc_dir_name and doc_dir != doc_dir.parent:
|
||||
if doc_dir == doc_dir.parent:
|
||||
raise ValueError(f"root_name ({doc_dir_name}) not in path ({str(Path(__file__))}).")
|
||||
|
||||
nav_title_map = {"cli": "CLI", "llms": "LLMs"}
|
||||
|
||||
|
||||
def generate_docs_for_src_code(
|
||||
code_dir: Path, target_doc_folder: str, ignored_modules: Iterable[Any] = []
|
||||
@@ -53,7 +55,9 @@ def generate_docs_for_src_code(
|
||||
if ignore:
|
||||
continue
|
||||
|
||||
nav_titles = [name.replace("_", " ").title() for name in parts]
|
||||
nav_titles = [
|
||||
nav_title_map.get(name, name.replace("_", " ").title()) for name in parts
|
||||
]
|
||||
nav[nav_titles] = doc_path.as_posix()
|
||||
|
||||
with mkdocs_gen_files.open(full_doc_path, "w") as f:
|
||||
@@ -69,7 +73,7 @@ def generate_docs_for_src_code(
|
||||
|
||||
|
||||
generate_docs_for_src_code(
|
||||
code_dir=doc_dir.parent / "libs" / "kotaemon",
|
||||
code_dir=doc_dir.parent / "libs" / "kotaemon" / "kotaemon",
|
||||
target_doc_folder="reference",
|
||||
ignored_modules={"contribs"},
|
||||
)
|
||||
|
Reference in New Issue
Block a user