Configuration

plissken is configured via plissken.toml in your project root.

Full Configuration Reference

[project]
# Project name (inferred from Cargo.toml or pyproject.toml if not set)
name = "myproject"

# Version source: "cargo", "pyproject", or "git"
version_from = "cargo"

[output]
# Output format (currently only "markdown" supported)
format = "markdown"

# Output directory for generated docs
path = "docs/api"

# Template/theme: "mkdocs-material" or "mdbook"
template = "mkdocs-material"

[rust]
# Rust crates to document (paths relative to project root)
crates = [
    ".",           # Root crate
    "crates/core", # Workspace member
]

[python]
# Python package name
package = "mypackage"

# Optional: source directory (defaults to package name)
# source = "src/mypackage"

Project Section

name

Project name used in documentation titles. Auto-detected from:

1. Cargo.toml → [package].name
2. pyproject.toml → [project].name

version_from

Where to read the version:

• "cargo" - From Cargo.toml
• "pyproject" - From pyproject.toml
• "git" - From git tags (default)

Output Section

path

Directory for generated documentation. Relative to project root.

path = "docs/api"      # Recommended for MkDocs
path = "src"           # For mdBook

template

Documentation template/theme:

Value	Description
mkdocs-material	MkDocs with Material theme (recommended)
mdbook	Rust-style mdBook

Rust Section

crates

List of Rust crates to document:

[rust]
crates = [
    ".",                    # Root crate
    "crates/plissken-core", # Workspace member
]

For workspaces, list each member you want documented.

Python Section

package

Python package name to document:

[python]
package = "mypackage"

source

Optional source directory override:

[python]
package = "mypackage"
source = "src/mypackage"  # If not in standard location

Validation

Check your configuration:

plissken check

This validates:

• Required fields are present
• Paths exist
• Rust crates compile
• Python packages are importable

Template Overrides

Create custom templates in .plissken/templates/:

.plissken/
  templates/
    partials/
      badge.html       # Override badge appearance
      signature.html   # Override function signatures
    module.html        # Override module page layout

Templates use Tera syntax (similar to Jinja2).