Version: 1.1.0

mojo doc

Generate API documentation from docstrings.

Essentials

• Point it at a package or a file.
• The first sentence of each docstring becomes the summary.
• Undocumented public names still appear, with an empty summary.
• Output is HTML you can open locally.

Example

$ mojo doc mymodule.mojo

Keep in mind

Generated docs are only as good as the docstrings. See docstrings.