plissken

Documentation generator for Rust-Python hybrid projects

plissken generates beautiful, unified documentation for projects that combine Rust and Python code, with special support for PyO3 and maturin bindings.

Features

• Unified Documentation - Single documentation site for both Python and Rust APIs
• Cross-Reference Links - Automatic bidirectional links between Python classes and their Rust implementations
• Multiple SSG Support - Generate docs for MkDocs Material or mdBook
• Smart Discovery - Auto-detect Python packages and Rust crates
• Customizable Themes - Full theme support with CSS variables for dark mode
• Template Overrides - Customize any template without forking

Installation

Quick Install (Linux/macOS)

curl -fsSL https://raw.githubusercontent.com/colliery-io/plissken/main/install.sh | bash

From crates.io

cargo install plissken

From Source

git clone https://github.com/colliery-io/plissken.git
cd plissken
cargo install --path crates/plissken-cli

Quick Start

# Initialize configuration in your project
plissken init

# Generate documentation
plissken render

# Serve with MkDocs
mkdocs serve

Documentation

Full documentation is available at https://colliery-io.github.io/plissken/

License

MIT License - see LICENSE for details.