doc-forge/mcp_docs/modules/docforge.renderers.mkdocs_renderer.json

{
  "module": "docforge.renderers.mkdocs_renderer",
  "content": {
    "path": "docforge.renderers.mkdocs_renderer",
    "docstring": "MkDocsRenderer\n\nGenerates Markdown source files compatible with MkDocs Material\nand mkdocstrings, ensuring:\n\n- Root index.md always exists\n- Parent package indexes are created automatically\n- Child modules are linked in parent index files\n- README.md can be generated from the root package docstring",
    "objects": {
      "Path": {
        "name": "Path",
        "kind": "alias",
        "path": "docforge.renderers.mkdocs_renderer.Path",
        "signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
        "docstring": null
      },
      "Project": {
        "name": "Project",
        "kind": "class",
        "path": "docforge.renderers.mkdocs_renderer.Project",
        "signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
        "docstring": "Represents a documentation project, serving as a container for modules.\n\nAttributes:\n    name: Name of the project.\n    modules: Dictionary mapping module paths to Module instances.",
        "members": {
          "name": {
            "name": "name",
            "kind": "attribute",
            "path": "docforge.renderers.mkdocs_renderer.Project.name",
            "signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
            "docstring": null
          },
          "modules": {
            "name": "modules",
            "kind": "attribute",
            "path": "docforge.renderers.mkdocs_renderer.Project.modules",
            "signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
            "docstring": null
          },
          "add_module": {
            "name": "add_module",
            "kind": "function",
            "path": "docforge.renderers.mkdocs_renderer.Project.add_module",
            "signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
            "docstring": "Add a module to the project.\n\nArgs:\n    module: The module to add."
          },
          "get_module": {
            "name": "get_module",
            "kind": "function",
            "path": "docforge.renderers.mkdocs_renderer.Project.get_module",
            "signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
            "docstring": "Retrieve a module by its dotted path.\n\nArgs:\n    path: The dotted path of the module (e.g., 'pkg.mod').\n\nReturns:\n    The requested Module."
          },
          "get_all_modules": {
            "name": "get_all_modules",
            "kind": "function",
            "path": "docforge.renderers.mkdocs_renderer.Project.get_all_modules",
            "signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
            "docstring": "Get all modules in the project.\n\nReturns:\n    An iterable of Module objects."
          },
          "get_module_list": {
            "name": "get_module_list",
            "kind": "function",
            "path": "docforge.renderers.mkdocs_renderer.Project.get_module_list",
            "signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
            "docstring": "Get the list of all module dotted paths.\n\nReturns:\n    A list of module paths."
          }
        }
      },
      "Module": {
        "name": "Module",
        "kind": "class",
        "path": "docforge.renderers.mkdocs_renderer.Module",
        "signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.Module')>",
        "docstring": "Represents a documented Python module or package.\n\nAttributes:\n    path: Dotted import path of the module.\n    docstring: Module-level docstring content.\n    members: Dictionary mapping object names to their DocObject representations.",
        "members": {
          "path": {
            "name": "path",
            "kind": "attribute",
            "path": "docforge.renderers.mkdocs_renderer.Module.path",
            "signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
            "docstring": null
          },
          "docstring": {
            "name": "docstring",
            "kind": "attribute",
            "path": "docforge.renderers.mkdocs_renderer.Module.docstring",
            "signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
            "docstring": null
          },
          "members": {
            "name": "members",
            "kind": "attribute",
            "path": "docforge.renderers.mkdocs_renderer.Module.members",
            "signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
            "docstring": null
          },
          "add_object": {
            "name": "add_object",
            "kind": "function",
            "path": "docforge.renderers.mkdocs_renderer.Module.add_object",
            "signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
            "docstring": "Add a documented object to the module.\n\nArgs:\n    obj: The object to add."
          },
          "get_object": {
            "name": "get_object",
            "kind": "function",
            "path": "docforge.renderers.mkdocs_renderer.Module.get_object",
            "signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
            "docstring": "Retrieve a member object by name.\n\nArgs:\n    name: The name of the object.\n\nReturns:\n    The requested DocObject."
          },
          "get_all_objects": {
            "name": "get_all_objects",
            "kind": "function",
            "path": "docforge.renderers.mkdocs_renderer.Module.get_all_objects",
            "signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
            "docstring": "Get all top-level objects in the module.\n\nReturns:\n    An iterable of DocObject instances."
          }
        }
      },
      "MkDocsRenderer": {
        "name": "MkDocsRenderer",
        "kind": "class",
        "path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer",
        "signature": "<bound method Class.signature of Class('MkDocsRenderer', 17, 242)>",
        "docstring": "Renderer that generates Markdown source files formatted for the MkDocs\n'mkdocstrings' plugin.",
        "members": {
          "name": {
            "name": "name",
            "kind": "attribute",
            "path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer.name",
            "signature": null,
            "docstring": null
          },
          "generate_sources": {
            "name": "generate_sources",
            "kind": "function",
            "path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources",
            "signature": "<bound method Function.signature of Function('generate_sources', 28, 66)>",
            "docstring": "Produce a set of Markdown files in the output directory based on the\nprovided Project models.\n\nArgs:\n    project:\n        The project model to render.\n\n    out_dir:\n        Target directory for generated Markdown.\n\n    module_is_source:\n        If True, treat the module as the root folder."
          },
          "generate_readme": {
            "name": "generate_readme",
            "kind": "function",
            "path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme",
            "signature": "<bound method Function.signature of Function('generate_readme', 68, 122)>",
            "docstring": "Generate README.md from the root package docstring.\n\nBehavior:\n\n- If module_is_source is True:\n    README.md is generated at project root (docs_dir.parent)\n\n- If module_is_source is False:\n    TODO: generate README.md inside respective module folders"
          }
        }
      }
    }
  }
}