feat: how-to for generated docs - #692
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //src:license-checkStatus: Click to expand output |
|
Documentation preview for this pull request is available at: |
There was a problem hiding this comment.
🟡 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_binpublicly 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 viadocs(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.
| ``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 |
📌 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
✅ Checklist