Open
Conversation
dccb7f5 to
2d5a71c
Compare
2d5a71c to
5871473
Compare
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.
Auto-generate a single-page YAML reference doc from the Pydantic models, so documentation stays in sync with the code.
Adds a new package
scripts/yaml_reference_docs/with this pipeline:keyword_tree.pyintrospect.pydoc_model.pyPageDoc,SectionDoc,ItemDoc)page_builder.pyPageDocready for renderingrender_markdown.pyPageDocto Markdown for Docusaurusexample_builder.pymdx.py<YYYY-MM-DD>)generate.pyindex.mdThe generator relies on
Field(title="KEYWORD")to discover YAML keywords. Several existing model fields were missingtitle, so this PR addsField(title=...)where needed. This has no runtime effect — it only adds metadata that Pydantic already supports.The generated page appears under About → YAML Overview in the sidebar.
How to review
Then navigate to YAML Overview in the sidebar.
Refs:
equinor/ecalc-internal#1613
Type of Work
See here (internal): https://github.com/equinor/ecalc-internal/discussions/1044
Have you remembered and considered?
docs/drafts/next.draft.md)docs/docs/migration_guides/)BREAKING:in footer or!in headerWhat is this PR all about?
What else did you consider?
Between the lines?