Repository navigation
Move documentation to lbuild.modm.dev - #91
Merged
Merged
Conversation
salkinium
force-pushed
the
feature/docs
branch
from
October 19, 2026 22:59
96b969b to
3acc806
Compare
Split the README into separate pages under docs/ using the same MkDocs Material setup as modm, and keep the README short with a link to lbuild.modm.dev. The content is moved unchanged, except for headings, links between the pages and short introductions where a section was split.
Fix examples that do not work with the current API: - Options require a description argument. - Generated module classes must return True from prepare(). - Archive folders in env.extract() must end with a slash. - env.collector() raises instead of returning None. - Fix syntax errors and renamed functions in the examples. - Replace deprecated APIs: env.query(default=...), env.get_generated_local_files() and repo.find_modules_recursive(). Document missing features used by modm: module.order, the path helpers like env.relcwdoutpath(), set option defaults, enum.Enum enumerations, collector_values() defaults, the Jinja2 collector_values global and relative includes, all CLI commands and arguments, remote Git repositories and the actual module execution order.
Pull requests upload the built homepage as an artifact, pushes to develop and develop-** branches deploy it to GitHub Pages.
salkinium
force-pushed
the
feature/docs
branch
from
October 19, 2026 23:05
3acc806 to
55af883
Compare
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README got a little long (1200 lines, lol), so this moves all the docs into an MkDocs site with the same Material setup as modm, to be hosted at lbuild.modm.dev. The README is now just the intro and a link.
facade.pyand how modm actually uses it:description, generated modules returningNonefromprepare(), archive folders without trailing/,env.collector()returningNone)env.query(default=...),env.get_generated_local_files(),repo.find_modules_recursive())module.order, theenv.relcwdoutpath()& co path helpers, all CLI commands, remote Git repositories and the real execution ordermake docsbuilds withmkdocs build --strict,make docs-servefor local previewbuild-homepage-testartifactdevelop/develop-**deploy to GitHub PagesMissing: Pages needs to be enabled with source "GitHub Actions" and the custom domain set in the repo settings. MkDocs is pinned to
<2, since Material doesn't support MkDocs 2.0.I also looked at pdoc for API docs of the facade classes, but they have zero docstrings and pdoc would show internal names like
ModuleInitFacade, so meh, maybe later with docstrings + mkdocstrings.