Skip to content

feat: how-to for generated docs - #692

Merged
AlexanderLanin merged 2 commits into
eclipse-score:mainfrom
etas-contrib:generated-docs-how-to
Aug 5, 2026
Merged

feat: how-to for generated docs#692
AlexanderLanin merged 2 commits into
eclipse-score:mainfrom
etas-contrib:generated-docs-how-to

Conversation

@a-zw

@a-zw a-zw commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

📌 Description

Adds a how-to for generating documentation.

As a little aside, makes a py_binary public, so it can be reused externally.

🚨 Impact Analysis

  • This change does not violate any tool requirements and is covered by existing tool requirements
  • This change does not violate any design decisions
  • Otherwise I have created a ticket for new tool qualification

✅ Checklist

  • Added/updated documentation for new or changed features
  • Added/updated tests to cover the changes
  • Followed project coding standards and guidelines

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //src:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 3fa758e5-d264-4044-b179-14eafcbcc8cc
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
WARNING: Target pattern parsing failed.
ERROR: Skipping '//src:license-check': no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
ERROR: no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
INFO: Elapsed time: 6.329s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-692: https://eclipse-score.github.io/docs-as-code/pr-692/

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The new how-to contains a documented default behavior for attach_to that does not match the existing mount semantics, and there is a small spelling issue in the BUILD comment.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Pull request overview

Adds new end-user documentation describing how to integrate build-time generated documentation into a Sphinx tree, and slightly broadens reuse of an existing generator tool by making a Bazel py_binary public.

Changes:

  • Make generate_metamodel_rst_bin publicly visible so other metamodels can reuse it.
  • Add a new “generated docs” how-to page and link it from the how-to index.
  • Document a 3-step pattern: generate RST via build action → wrap in docs_bundle → mount via docs(bundles=[...]).
File summaries
File Description
src/extensions/score_metamodel/docs/BUILD Changes Bazel visibility to allow external reuse of the metamodel RST generator binary.
docs/how-to/index.rst Adds the new how-to page to the documentation toctree.
docs/how-to/generated_docs.rst Introduces a step-by-step guide for mounting generated documentation via docs_bundle.
Review details
  • Files reviewed: 3/3 changed files
  • Comments generated: 2
  • Review effort level: Lite

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Comment on lines +90 to +91
``mount_at`` sets the target path; ``attach_to`` adds the page to that
document's toctree (defaults to the parent ``index`` when omitted).
main = "generate_metamodel_rst.py",
deps = all_requirements,
visibility = ["//visibility:private"],
visibility = ["//visibility:public"], # public to be reuseable for other metamodels
@AlexanderLanin
AlexanderLanin merged commit fd952ac into eclipse-score:main Aug 5, 2026
15 of 17 checks passed
@AlexanderLanin
AlexanderLanin deleted the generated-docs-how-to branch August 5, 2026 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

3 participants