Special
Extract documentation from special
Docu is a documentation generator for Python code that extracts documentation from special #/
comment lines. It provides a straightforward way to document your Python code while keeping the documentation close to the code it describes.
#/
comment lines in your Python code#/ MyClass - A simple example class
class MyClass:
#/ Initialize the class with a name
def __init__(self, name: str):
self.name = name
#/ Return a greeting using the name
def greet(self) -> str:
return f"Hello, {self.name}!"
Generate documentation with:
python -m docu example.py --format html --output-dir docs