[AUR-405] Auto-generate markdown documentation from pipeline (#33)

* Create a script to auto-generate markdown docs from pipeline
* Clean up documentation for Chain-of-Thought
This commit is contained in:
Nguyen Trung Duc (john)
2023-10-04 10:54:24 +07:00
committed by GitHub
parent 6ab1854532
commit 49ed3f6994
5 changed files with 109 additions and 8 deletions

View File

@@ -52,6 +52,29 @@ def run(run_path):
check_config_format(run_path)
@main.command()
@click.argument("module", required=True)
@click.option(
"--output", default="docs.md", required=False, help="The output markdown file"
)
@click.option(
"--separation-level", required=False, default=1, help="Organize markdown layout"
)
def makedoc(module, output, separation_level):
"""Make documentation for module `module`
Example:
\b
# Make component documentation for kotaemon library
$ kh makedoc kotaemon
"""
from kotaemon.contribs.docs import make_doc
make_doc(module, output, separation_level)
print(f"Documentation exported to {output}")
@main.command()
@click.option(
"--template",