-
Notifications
You must be signed in to change notification settings - Fork 15
Docs #28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs #28
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds documentation generation support to the reference integration workspace using Bazel and Sphinx. The changes enable building comprehensive documentation from multiple integrated S-CORE modules via the bazel run //:docs_combo_experimental command.
- Enables documentation building through Bazel by adding the
score_docs_as_codeandscore_processdependencies - Configures Sphinx documentation with module collection support for
score_platformandscore_process - Sets up a GitHub Actions workflow for automated documentation builds and deployments
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| score_modules.MODULE.bazel | Adds score_docs_as_code (v2.0.1) and score_process (v1.3.1) dependencies; switches score_persistency to version override; switches score_platform to git override for fixes |
| docs/requirements.txt | Removes placeholder file (no longer needed) |
| docs/index.rst | Creates main documentation page with reference to platform and process module documentation |
| docs/conf.py | Adds Sphinx configuration with project metadata and required extensions |
| README.md | Documents the new docs generation command |
| BUILD | Uncomments and configures the docs() rule with data dependencies |
| .gitignore | Adds documentation build artifacts to ignore list |
| .github/workflows/docs.yml | Adds GitHub Actions workflow for building and deploying documentation |
| .bazelrc | Adds Java 17 configuration required for Bazel build |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "@score_platform//:needs_json", | ||
| "@score_process//:needs_json", | ||
| # Persistency cannot be included, as it does not contain any needs. | ||
| # -> sphinx-needs bug? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue created useblocks/sphinx-needs#1569
First version which supports
bazel run //:docs_combo_experimental