Modo🧯 v0.11.1

Modo🧯 v0.11.1

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

Changelog

Bugfixes

• Fixes command init to support remote repos cloned with SSH (#221, #223)

Other

• Internal: splits up the Processor mega-struct (#218, #219)

Modo🧯 v0.11.0

Modo🧯 v0.11.0

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

Changelog

Features

• Supports renaming of re-exports like in from .mod import X as Y (#189)
• Adds automatic linking from doc pages to the containing module's source (#195)
• Adds flag --config to all commands, for working with an alternative config file (#202)
• Struct methods can inherit docs from a parent trait (#208)

Documentation

• Adds a user guide section on Modo's doc-testing vs. mojo test (#215)

Bugfixes

• Don't warn on missing self arg docs, also for traits (#210)

Other

• Doc-tests parser supports quadruple backticks (#194)
• Project setup fully supports GitLab remotes, incl. self-hosted (#199)
• Omits the test function for purely global doc-tests (#200)

Modo🧯 v0.10.1

Modo🧯 v0.10.1

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

Changelog

Documentation

• Extends the user guide section on templates (#188)

Bugfixes

• Updates the examples in the CLI help to match the new features of v0.10.0 (#187)

Modo🧯 v0.10.0

Modo🧯 v0.10.0

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

Release highlights

Modo🧯 v0.10.0 brings some major usability improvements:

• Command init now analyzes the structure of the Mojo project and sets everything up to work instantly.
• Flag --watch introduces a watch mode, so that edits can be reviewer in a web browser instantly.
• Flag --report-missing reports missing docstrings and a documentation coverage percentage.
• Command clean cleans up a project from Markdown and test files generated by Modo.

Changelog

Features

• Adds flag/config entry report-missing to report missing docstrings and coverage (#136, #137)
• Command init tries to find packages to set up an instantly working project (#141)
• Command init adds pre- and post-processing scripts to modo.yaml file (#141)
• Command init creates a docs directory with sub-directories reflecting the recommended structure (#141)
• Command init has flag --docs to change the intended documentation directory (#142)
• Command init has flag --no-folders to skip creation of directories (#143)
• Command init writes a .gitignore file to the docs folder (#145)
• With format hugo, set up site with hugo.yaml and go.mod (#155)
• Adds flag --watch to re-build on changes (#174)
• Adds command clean to remove Markdown and test files generated by Modo (#178)

Documentation

• Restructures docs/ to serve as full Hugo example that uses all features (#134)
• Rewrites the user guide for the new workflow with batteries-included init (#161)
• Adds a sub-sction on CLI flags to the user guide (#175)
• Adds a user guide section on CLI commands (#179)

Other

• Includes fn/def and @staticmethod in function and method signatures (#139)
• Improves message on script errors with hint to flag --bare (#144)
• Checks that user template directories actually exist (#157)
• mdBook config and CSS files are written by command init instead of build (#158)
• Disables post-processing scripts on dry-run (#175)

Modo🧯 v0.9.0

Modo🧯 v0.9.0

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

Release highlights

Modo🧯 v0.9.0 adds support for extracting doc-tests also from additional Markdown files.

Changelog

Features

• A folder can be given as input, for all JSON files getting processed recursively (#118)
• With an input folder, doc-tests are also extracted from Markdown files (#119)

Documentation

• Adds user guide section on pre- and post-processing bash scripts (#125)

Bugfixes

• Fixes #80: short link labels for module aliases (#121)

Other

• Doctests are written in a sub-folder for each package (#116)
• Moves signatures to a separate template (#128)

Modo🧯 v0.8.1

Modo🧯 v0.8.1

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

Changelog

Modo🧯 is now available on PyPI as pymodo. (#102, #104)

Modo🧯 v0.8.0

Modo🧯 v0.8.0

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

Changelog

Breaking changes

• Rework of the command line interface to use sub-commands init, build and test (#91)

Features

• Optionally extracts doc-tests to run with mojo test (#81, #88)
• CLI flags can be stored in a modo.yaml config file (#90, #94)
• Shell commands to run before and after docs processing can be given in modo.yaml (#90)

Documentation

• Moves most of the documentation to the user guide on GitHub Pages (#82, #83, #84)

Performance

• Speedup by avoiding repeated RegExp compilation (#89)

Modo🧯 v0.7.0

Modo🧯 v0.7.0

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

Changelog

Features

• Adds CLI flag --strict to break with an error instead of warnings (#68)
• Adds CLI flag --dry-run to run without file output (#71)
• Allows to re-export aliases on package level (#73)
• Allows for cross-refs to aliases in packages, modules and structs (#69, #73)

Documentation

• Replaces the mdBook stdlib example by a custom one using Hugo (#64)

Bugfixes

• Don't trim docstrings during extraction and removal of exports section (#60)
• Fixes broken links when referencing parents or the root package (#62)

Other

• Checks package re-exports for correct paths (#68)
• Checks package re-exports for resulting name conflicts (#72)
• More consistent line breaks in Markdown output (#75)

Modo🧯 v0.6.0

Modo🧯 v0.6.0

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

Changelog

Features

• Implements output customization by (partial) template overwrites (#48)
• Adds support for YAML input, particularly for shorter test files (#49)

Bugfixes

• Fixes overwritten cross-refs in case of multiple re-exports of the same member (#46)
• Performs link replacement as the very last rendering step, allowing for refs in summaries (#47)

Modo🧯 v0.5.0

Modo🧯 v0.5.0

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

Changelog

Features

• Adds CLI flag --short-links to strip packages and modules from link labels (#41)
• Supports re-structuring doc output according to package re-exports (#42)