docs: split towards multiple docs_bundles - #443
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //:license-checkStatus: Click to expand output |
There was a problem hiding this comment.
Pull request overview
Splits monolithic documentation into composable component and subcomponent bundles.
Changes:
- Adds documentation bundles for Launch Manager, Lifecycle Client, and Health Monitor.
- Introduces bundle mount-point indexes and updates Sphinx references.
- Moves Sphinx configuration into the Bazel documentation rule.
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
BUILD |
Configures root documentation and component bundles. |
conf.py |
Removes obsolete standalone Sphinx configuration. |
docs/index.rst |
Updates paths for the new source root and bundle index. |
docs/components/index.rst |
Adds the component bundle mount point. |
docs/manuals/user_manual.rst |
Uses the release-notes reference label. |
docs/release/index.rst |
Defines the release-notes label. |
score/health_monitor/BUILD |
Defines the Health Monitor documentation bundle. |
score/launch_manager/BUILD |
Defines the Launch Manager bundle and nested client bundle. |
score/launch_manager/docs/index.rst |
Routes subcomponent documentation through its mount point. |
score/launch_manager/docs/subcomponents/index.rst |
Adds the subcomponent bundle mount point. |
score/launch_manager/src/lifecycle_client/BUILD |
Defines the Lifecycle Client documentation bundle. |
score/launch_manager/src/daemon/src/configuration/README.rst |
Documents configuration schema usage and structure. |
score/launch_manager/src/daemon/src/configuration/config_schema/BUILD |
Exposes schema files to documentation bundles. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
The created documentation from the pull request is available at: docu-html |
MaciejKaszynski
left a comment
There was a problem hiding this comment.
Please could you also update the description of the PR to be more descriptive of the changes.
|
|
||
| score/launch_manager/docs/index | ||
| score/health_monitor/docs/index | ||
| components/index |
There was a problem hiding this comment.
This changes URLs but I guess that is ok for lifecycle as it is unlikely there are many links floating around.
This pull request introduces significant improvements to the documentation build system by modularizing documentation bundles for components and subcomponents, updating Sphinx configuration, and improving navigation structure. The changes make it easier to manage, build, and browse documentation for the
launch_managerandhealth_monitorcomponents and their subcomponents.Documentation Build System Improvements:
docs_bundleBazel targets for bothscore/launch_managerandscore/health_monitor, enabling modular, component-specific documentation builds. Subcomponent documentation is now bundled and mountable at specified paths for better organization.BUILDfile to aggregate component documentation using the new bundle system and added project metadata for improved documentation context.components/index.rstandsubcomponents/index.rstfiles, allowing dynamic population of navigation trees via thedocs_bundlesystem. This replaces hardcoded paths with a more maintainable structure.conf.pySphinx configuration in favor of Bazel-driven configuration, simplifying the build process and reducing maintenance overhead.These changes collectively modernize and modularize the documentation workflow, making it more scalable and maintainable as the project grows.