Modo🧯

Modo🧯 is a documentation generator (DocGen) for the Mojo🔥 programming language. It generates Markdown for static site generators (SSGs) from mojo doc JSON output.

This example in the User guide shows a Mojo🔥 package processed with Modo🧯 and rendered with Hugo, to demonstrate Modo🧯's features.

Features

Generates Mojo🔥 API docs for Hugo, mdBook or just plain Markdown.
Super easy to set up for an existing Mojo🔥 project.
Provides a simple syntax for code cross-references.
Optionally structures API docs according to package re-exports.
Optionally extracts doc-tests for mojo test from code blocks.
Customizable output through user templates.

See the User guide for more information. See the Modo🧯 slides for a feature overview.

Installation

Using Python

Modo🧯 is available on PyPI as pymodo. Install it with pip:

pip install pymodo

This installs the modo command. If the command is not found, try:
python -m pymodo

Using Go

With Go installed, you can install Modo🧯 like this:

go install github.com/mlange-42/modo@latest

With Go, you can also install the latest development version:
go install github.com/mlange-42/modo@main

Precompiled binaries

Pre-compiled binaries for manual installation are available in the Releases for Linux, Windows and MacOS.

Usage

To initialize an existing Mojo🔥 project for Modo🧯 and an SSG like Hugo, run command init once:

modo init hugo

This sets up everything to be able to build Markdown files for the target SSG with command build:

modo build

Finally, serve or build the site with the target SSG (here Hugo):

hugo serve -s docs/site/

See Project setup for details and other supported SSGs.

Packages using Modo🧯

Larecs🌲 -- a performance-centred archetype-based ECS (docs).
ExtraMojo -- a collection of useful things that aren't (yet) in the standard library (docs).

License

This project is distributed under the MIT license.

Metadata

Release files for pymodo 0.11.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pymodo 0.11.13
File	Size	Uploaded
pymodo-0.11.13.tar.gz	10.0 MB	Mar 27, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for pymodo 0.11.13
File	Interpreter	ABI	Platform	Reset
pymodo-0.11.13-py3-none-any.whl 9.9 MB Mar 27, 2026	Python 3	none	any	Details

Total release size: 19.8 MB

Release files / pymodo-0.11.13.tar.gz

Download URL	pymodo-0.11.13.tar.gz
Size	10.0 MB
Tags	Source
SHA-256 checksum How to use checksums	`22c517e9efd8502e50402d7f316a0960a7d57b57a42ed2ad140bf1422dd0ef0d`
BLAKE2b-256 checksum How to use checksums	`437e6adfb6846987b0636c2de33c53b004f94af99b054840cc7fb6738d9d7913`
Upload date	Mar 27, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.13.12`

Release files / pymodo-0.11.13-py3-none-any.whl

Download URL	pymodo-0.11.13-py3-none-any.whl
Size	9.9 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`a6ae39e5c00452fa7df8b5163c5f20de7dbe660a184618cd8869e913038a7c34`
BLAKE2b-256 checksum How to use checksums	`4b8990600d5b873c2f0e63f4f8494821dbc6c7c0bec18149006f203c532f676e`
Upload date	Mar 27, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.13.12`