Skip to content

Docs

docs

DocsTool — one-shot documentation tree dump.

DocsTool

Bases: AXMTool

Dump README + mkdocs + docs tree in one call.

Registered as ast_docs via axm.tools entry point.

Source code in packages/axm-ast/src/axm_ast/tools/docs.py
Python
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
class DocsTool(AXMTool):
    """Dump README + mkdocs + docs tree in one call.

    Registered as ``ast_docs`` via axm.tools entry point.
    """

    @property
    def name(self) -> str:
        """Return tool name for registry lookup."""
        return "ast_docs"

    @safe_execute
    def execute(
        self,
        *,
        path: str = ".",
        detail: str = "full",
        pages: list[str] | None = None,
        **kwargs: object,
    ) -> ToolResult:
        """Dump project documentation.

        Args:
            path: Project root directory.
            detail: Detail level — ``toc``, ``summary``, or ``full``.
            pages: Page name substrings to filter (case-insensitive).
            **kwargs: Reserved for future use.

        Returns:
            ToolResult with documentation data.
        """
        project_path = Path(path).resolve()
        if not project_path.is_dir():
            return ToolResult(success=False, error=f"Not a directory: {project_path}")

        from axm_ast.core.docs import discover_docs, format_docs_json

        result: DocsResult = discover_docs(project_path, detail=detail, pages=pages)
        return ToolResult(
            success=True,
            data=cast("dict[str, object]", format_docs_json(result)),
        )
name property

Return tool name for registry lookup.

execute(*, path='.', detail='full', pages=None, **kwargs)

Dump project documentation.

Parameters:

Name Type Description Default
path str

Project root directory.

 '.'
detail str

Detail level — toc, summary, or full.

 'full'
pages list[str] | None

Page name substrings to filter (case-insensitive).

 None
**kwargs object

Reserved for future use.

 {}

Returns:

Type Description
ToolResult

ToolResult with documentation data.
Source code in packages/axm-ast/src/axm_ast/tools/docs.py
Python
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
@safe_execute
def execute(
    self,
    *,
    path: str = ".",
    detail: str = "full",
    pages: list[str] | None = None,
    **kwargs: object,
) -> ToolResult:
    """Dump project documentation.

    Args:
        path: Project root directory.
        detail: Detail level — ``toc``, ``summary``, or ``full``.
        pages: Page name substrings to filter (case-insensitive).
        **kwargs: Reserved for future use.

    Returns:
        ToolResult with documentation data.
    """
    project_path = Path(path).resolve()
    if not project_path.is_dir():
        return ToolResult(success=False, error=f"Not a directory: {project_path}")

    from axm_ast.core.docs import discover_docs, format_docs_json

    result: DocsResult = discover_docs(project_path, detail=detail, pages=pages)
    return ToolResult(
        success=True,
        data=cast("dict[str, object]", format_docs_json(result)),
    )