plissken 0.0.2

Documentation generator for Rust-Python hybrid projects using PyO3 and maturin
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

<p align="center">
  <img src="image.png" alt="plissken logo" width="200">
</p>

# plissken

[![CI](https://github.com/colliery-io/plissken/actions/workflows/ci.yml/badge.svg)](https://github.com/colliery-io/plissken/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/plissken.svg)](https://crates.io/crates/plissken)
[![Documentation](https://docs.rs/plissken/badge.svg)](https://docs.rs/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](https://pyo3.rs/) and [maturin](https://www.maturin.rs/) 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)

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

### From crates.io

```bash
cargo install plissken
```

### From Source

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

## Quick Start

```bash
# 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/](https://colliery-io.github.io/plissken/)

## License

MIT License - see [LICENSE](LICENSE) for details.