Skip to content

feat: support toctree_index parameter - #844

Merged
AlexanderLanin merged 6 commits into
mainfrom
toctree_index
Sep 22, 2026
Merged

AlexanderLanin merged 6 commits into
mainfrom
toctree_index

Conversation

@a-zw

@a-zw a-zw commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

📌 Description

Sphinx-mount provides a toctree_index parameter but our wrapper did not provide it yet.

🚨 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

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.

Copilot review overview

🟡 Changes recommended

Moderate issues remain in TOML round-tripping and negative-index validation; file-list coverage and contract documentation also need updates.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 2 Medium severity · 1 Low severity

Open (3)
What changed in this PR

Adds toctree_index support across Bazel bundle composition, manifests, runtime mounting, tests, and documentation.

Changes:

  • Propagates and validates the placement index.
  • Updates nested-bundle fixtures and expected outputs.
  • Documents the new configuration option.
File Summary
src/​tests/​docs_bzl/​scenarios/​nested_bundles/​host_docs/​concepts/​index.rst Adds a second target toctree.
src/​tests/​docs_bzl/​scenarios/​nested_bundles/​BUILD Configures index 1.
src/​tests/​docs_bzl/​scenarios/​nested_bundles/​_expected/​ordered_aggregate_manifest.json Updates aggregate metadata.
src/​tests/​docs_bzl/​scenarios/​nested_bundles/​_expected/​mounts_manifest.json Updates mount metadata.
src/​tests/​docs_bzl/​scenarios/​nested_bundles/​_expected/​docs/​concepts/​index.html Updates rendered placement.
src/​tests/​docs_bzl/​scenarios/​nested_bundles/​_expected/​docs/​concepts/​example_bundle/​child/​landing.html Updates navigation output.
src/​extensions/​score_mounts/​tests/​test_resolver.py Tests parsing and defaults.
src/​extensions/​score_mounts/​_resolver.py Parses the new manifest field. Moderate: reject negative indices (3 votes).
src/​extensions/​score_mounts/​__init__.py Passes the index to runtime mounts. Moderate: preserve non-default indices in TOML serialization (3 votes); Nit: cover the file-list path (2 votes).
docs/​reference/​bazel_macros.rst Documents the macro parameter.
docs/​how-to/​bundles/​index.rst Documents placement semantics.
docs/​concepts/​mounts/​index.rst Documents mount behavior. Nit: update the maintainer-facing manifest contract (1 vote).
bzl/​mount_rules.bzl Emits index metadata in manifests.
bzl/​bundle_rules.bzl Propagates and validates bundle placement indices.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/extensions/score_mounts/__init__.py
Comment thread src/extensions/score_mounts/_resolver.py Outdated
Comment thread src/extensions/score_mounts/__init__.py
@github-actions

Copy link
Copy Markdown
Contributor

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

@AlexanderLanin

Copy link
Copy Markdown
Member

See AI feedback, otherwise LGTM, lets merge this after #841

@AlexanderLanin

Copy link
Copy Markdown
Member

New PR overview attempt: Please mark the PR as ready for review once conflicts are resolved

@AlexanderLanin

Copy link
Copy Markdown
Member

@copilot merge latest main branch in here. mark the PR as ready for review once done.

Copilot AI commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

@copilot merge latest main branch in here. mark the PR as ready for review once done.

Merged main into this branch in b18e53c and pushed the follow-up conflict-resolution fixes through bb70cc3. I can’t mark the PR ready for review with the tools available in this session.

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.

Copilot review overview

🟡 Changes recommended

Generated TOML drops the new setting, while manifest validation and expected output still contain correctness gaps.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1 High severity · 4 Medium severity · 1 Low severity

Open (6)

Comment thread src/extensions/score_mounts/_resolver.py
Comment thread src/extensions/score_mounts/_resolver.py Outdated

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.

Copilot review overview

🔵 Needs a closer look

Generated ubproject.toml files currently discard toctree_index, causing downstream consumers to use the wrong toctree.

Review effort: Balanced
Findings: 1 Medium severity · 1 Low severity

Open (2)
Resolved since last review (4)

@AlexanderLanin
AlexanderLanin merged commit 98d6715 into main Sep 22, 2026
25 checks passed
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.

4 participants