Wikin

Documentation generated by Wikin.

Module: wikin

Wikin - A simple and beautiful documentation generator for Python.

Module: wikin.__main__

CLI entry point for Wikin.

Functions

main function
main()

Main entry point for the Wikin CLI tool. Parses command line arguments and initiates documentation generation.

Module: wikin.generator

Generator module for Wikin. Handles HTML generation from documentation data.

Classes

WikinGenerator class

Generates a premium-look HTML documentation from parsed module data.

__init__ method
__init__(self, project_name, version)

Initialize the generator with project metadata.

generate method
generate(self, modules)

Transforms a list of ModuleDoc objects into a single HTML string.

save method
save(self, html, output_path)

Saves the generated HTML to the specified file path.

Module: wikin.parser

Parser module for Wikin. Handles AST analysis of Python files.

Classes

ModuleDoc class

Holds documentation data for a single Python module.

WikinParser class

A parser that scans Python files for docstrings and specially formatted variable comments.

__init__ method
__init__(self, root_dir)

Initialize the parser with a root directory or a single file path.

parse method
parse(self)

Perform a recursive search for Python files and extract documentation from them.

Returns: List[ModuleDoc]: A list of documented modules found.

_parse_file method
_parse_file(self, file_path, module_name)

Parses a single Python file using the ast module.

Args: file_path: Path to the .py file. module_name: Dot-separated module name.

Returns: ModuleDoc containing extracted documentation.

_parse_function method
_parse_function(self, node)

Internal helper to create a FunctionDoc from an AST node.