feat: support custom bundle entry - #799
Closed
AlexanderLanin wants to merge 2 commits into
Closed
Conversation
AlexanderLanin
force-pushed
the
pr/entry-doc-support
branch
from
September 3, 2026 06:27
067647e to
d447fe9
Compare
Contributor
|
Documentation preview for this pull request is available at: |
AlexanderLanin
force-pushed
the
pr/entry-doc-support
branch
2 times, most recently
from
September 3, 2026 06:39
58b42aa to
2526b24
Compare
AlexanderLanin
force-pushed
the
pr/entry-doc-support
branch
from
September 3, 2026 06:42
2526b24 to
acc41a2
Compare
AlexanderLanin
changed the title
There was a problem hiding this comment.
🟡 Changes recommended
The public custom entry value is never passed to the generated configuration, so it remains fixed to index.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds Sphinx root-document configuration intended to support custom bundle entry pages.
Changes:
- Adds
entry_docto generated configuration rules. - Renders
entry_docas Sphinxmaster_doc.
File summaries
| File | Description |
|---|---|
docs.bzl |
Adds generated-config substitution and attribute. |
default_conf.py.tpl |
Sets the generated Sphinx master_doc. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| "project": attr.string(mandatory = True), | ||
| "project_url": attr.string(mandatory = True), | ||
| "required_in_id": attr.string(mandatory = True), | ||
| "entry_doc": attr.string(default = "index"), |
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.
Why this matters
The
docs_bundle(entry_doc = ...)API can name a bundle entry page other thanindex, but generated Sphinx configurations still selectindexasmaster_doc. Such bundles cannot use the generated configuration path when their entry page has another name.What changed
entry_docto the generated-configuration rule.master_doc, retainingindexas the default.conf.pyfiles authoritative.This PR is independent of the exporter and bundle-declaration changes. The later local-export layer consumes this generated configuration for source-bearing bundles.