Use env from nomad-docs#144
Merged
ka-sarthak merged 3 commits intomainfrom Jul 1, 2025
Merged
Conversation
Reviewer's GuideThis PR updates the mkdocs build to use the relocated Class diagram for env macro import changeclassDiagram
class EnvMacros {
<<module>>
+macros
}
class NomadDocs {
<<package>>
+env
}
EnvMacros <.. NomadDocs : import env from
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @ka-sarthak - I've reviewed your changes and they look great!
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull Request Overview
This PR updates the source of the MkDocs macros environment to the new nomad-docs package and adds it as a development dependency.
- Adds
nomad-docsto dev dependencies inpyproject.toml - Updates the import in
docs/main.pyfromnomad.mkdocstonomad_docs
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pyproject.toml | Added nomad-docs to the dev dependency list |
| docs/main.py | Updated define_env import path for MkDocs |
Collaborator
Author
|
@hampusnasstrom: Small bug fix we discussed sometime ago, please take a look. |
hampusnasstrom
approved these changes
Jul 1, 2025
Collaborator
hampusnasstrom
left a comment
There was a problem hiding this comment.
Perfect, thank you!
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.
envcontaining the macros for mkdocs is now moved tonomad-docs, update the importSummary by Sourcery
Use the macros environment provided by the nomad-docs package for mkdocs and update project dependencies accordingly.
Enhancements:
Build: