Merged
Conversation
roxell
force-pushed
the
migrate-mkdocs-to-zensical
branch
from
867ba3d to
5a1eb3a
Compare
mwasilew
reviewed
Mar 26, 2026
Contributor
mwasilew
left a comment
mwasilew
left a comment
There was a problem hiding this comment.
LGTM. There are some minor comments. Feel free to ignore. I tested the pip based setup and it works great!
| @@ -0,0 +1,238 @@ | |||
| #!/usr/bin/env python3 | |||
Contributor
There was a problem hiding this comment.
did you forget copyright?
| try: | ||
| steps = content["run"]["steps"] | ||
| except (KeyError, TypeError): | ||
| log.warning("%s: missing run.steps", filepath) |
Contributor
There was a problem hiding this comment.
can this happen with a valid test definition?
Collaborator
Author
There was a problem hiding this comment.
Can I fix this in a follow up PR where we also fix validate.py script to check for missing run.steps ?
Contributor
There was a problem hiding this comment.
I think this is the best way forward. At the moment there is no check that prevents adding a test definition file without steps.
Collaborator
Author
There was a problem hiding this comment.
right we need to add that into validate.py...
this can happen if the file is badly formatted I think
roxell
force-pushed
the
migrate-mkdocs-to-zensical
branch
from
5a1eb3a to
3587afc
Compare
mwasilew
approved these changes
Mar 26, 2026
The custom mkdocs plugin tied doc generation to the build tool. Replace it with a plain script that generates the same output. Remove mkdocs_plugin/ directory. Move requirements to requirements-docs.txt. Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
mkdocs is not actively maintained anymore. Switch to zensical and drop mkdocs, mkdocs-material, mkdocs-exclude, and the mwasilew/mkdocs-plugin-tags fork. Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
Add uv-based workflow for building docs locally. Update pip instructions to match the new tool. Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
roxell
force-pushed
the
migrate-mkdocs-to-zensical
branch
from
3587afc to
4313b9d
Compare
bhcopeland
approved these changes
Mar 27, 2026
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
3 participants
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 custom mkdocs plugin and the forked tags plugin made the doc build fragile. This pulls the doc generation out into a standalone script and switches the build tool.
mkdocs is not maintained anymore. See The Slow Collapse of MkDocs.
We depended on a custom mkdocs plugin and a forked tags plugin (mwasilew/mkdocs-plugin-tags). Both are now removed.
As I understand it Zensical is built by the mkdocs-material team and is the most active one. It builds faster and reads mkdocs.yml.
Signed-off-by: Anders Roxell anders.roxell@linaro.org