inkpot src docs

inkpot used on inkpot pkg:

inkpot/

inkpot/file.py

class File()

File is for interacting with a single file

class MarkDownVisitor(ast.NodeVisitor)

A custom NodeVisitor class for markdown files.
When a class or function are visited their
names and docstrings are printed.

@staticmethod
def get_line_def(node)
None

@staticmethod
def get_docstring(node)
None

@staticmethod
def link_children(node)
None

@staticmethod
def ouput(node, header, docstring)
None

def visit_ClassDef(self, node)
None

def visit_FunctionDef(self, node)
None

def visit_AsyncFunctionDef(self, node)
None

def __init__(self, path: str)
constructor

def parse(self)
parse the file

def output(self)
outputs all node-types and their respective docstrings

inkpot/init.py

inkpot/main.py

def main()
None

inkpot/directory.py

class Directory()

Directory is for interacting with a directory and its subdirs

def __init__(self, path)
constructor

def collect_files(self)
find all the files in dir

def parse_files(self)
filter all files in dir

def output(self)
output all the files in dir to the user

def header_output(self)
outputs the dir header