Skip to content

Move sphinx build to execution phase #48

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.

Sign up for GitHub

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

Closed
ramceb wants to merge 1 commit into from
Closed

Move sphinx build to execution phase #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 51 additions & 2 deletions BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,66 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")
load("@score_docs_as_code//:docs.bzl", "docs")

docs(
data = [
"@score_platform//:needs_json",
"@score_process//:needs_json",
# "@score_platform//:",
"@score_process//:sphinx_docs_library",
"@score_baselibs//:sphinx_docs_library",
# Persistency cannot be included, as it does not contain any needs.
# -> sphinx-needs bug?
# "@score_persistency//:needs_json",
],
source_dir = "docs",
deps = [
],
)

source_dir = "docs"

sphinx_docs(
name = "html",
Copy link
Contributor

@a-zw a-zw Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to do essentially the same as bazel run :docs_combo_experimental except that it does not work incrementally but run sphinx-build from scratch all the time. This is good for determinism but slower when used interactively.

I proposed something similar in eclipse-score/docs-as-code#286 but we abandoned it because experience was that supporting multiple ways to build stuff was not reliable enough.

Copy link
Author

@ramceb ramceb Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a very similar approach. Thanks for the hint.

srcs = glob(
[
source_dir + "/**/*.png",
source_dir + "/**/*.svg",
source_dir + "/**/*.md",
source_dir + "/**/*.rst",
source_dir + "/**/*.html",
source_dir + "/**/*.css",
source_dir + "/**/*.puml",
source_dir + "/**/*.need",
source_dir + "/**/*.yaml",
source_dir + "/**/*.json",
source_dir + "/**/*.csv",
source_dir + "/**/*.inc",
"more_docs/**/*.rst",
],
allow_empty = True,
),
config = ":" + source_dir + "/conf.py",
extra_opts = [
"-W",
"--keep-going",
"-T", # show more details in case of errors
"--jobs",
"auto",
],
formats = ["html"],
sphinx = ":sphinx_build",
tools = [],
visibility = ["//visibility:public"],
# Modules export their docs as sphinx_docs_library
# which are imported by bazel to docs/modules/<module_name>
deps = [
"@score_platform//:sphinx_docs_library",
"@score_process//:sphinx_docs_library",
"@score_baselibs//:sphinx_docs_library",
# "@score_persistency//:sphinx_docs_library",
# "@score_communication//:sphinx_docs_library"
],
)

# Simple filegroup target to demonstrate the build system works
Expand Down
3 changes: 2 additions & 1 deletion MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,10 @@ git_override(
module_name = "trlc",
remote = "https://github.com/bmw-software-engineering/trlc.git",
commit = "650b51a47264a4f232b3341f473527710fc32669", # trlc-2.0.2 release
# commit = "650b51a47264a4f232b3341f473527710fc32669", # trlc-2.0.2 release
)

# imports for the feature showcase module
bazel_dep(name = "rules_rust", version = "0.61.0")
bazel_dep(name = "rules_rust", version = "0.67.0")
bazel_dep(name = "score_itf", version = "0.1.0")
bazel_dep(name = "score_crates", version = "0.0.4")
25 changes: 18 additions & 7 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,25 @@ Reference Integration Documentation

Release Notes: :need:`doc__score_v05_alpha_release_note`

Documentation:
--------------

.. if-collection:: score_platform
.. toctree::
:maxdepth: 1
:titlesonly:

Documentation:
modules/score_process+/process/index
modules/score_platform+/docs/index

.. toctree::
:maxdepth: 1
:titlesonly:

S-CORE Platform <_collections/score_platform/docs/index>
_collections/score_process/process/index
Modules
-------


.. toctree::
:maxdepth: 1
:titlesonly:

modules/score_baselibs+/docs/index
..
modules/score_persistency+/docs/index
15 changes: 11 additions & 4 deletions score_modules.MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@
# *******************************************************************************

bazel_dep(name = "score_baselibs")
single_version_override(
git_override(
module_name = "score_baselibs",
version = "0.1.3",
commit = "826955b4d7dc2f326e3deabc06895318922cca1f",
remote = "https://github.com/eclipse-score/baselibs.git",
)

bazel_dep(name = "score_communication")
Expand Down Expand Up @@ -60,9 +61,15 @@ single_version_override(
)

bazel_dep(name = "score_docs_as_code", version = "2.0.1")
single_version_override(
# single_version_override(
# module_name = "score_docs_as_code",
# version = "2.0.1",
# )

git_override(
module_name = "score_docs_as_code",
version = "2.0.1",
commit = "c27915a2c5222a2e7111ba8db0cd468110b70178",
remote = "https://github.com/eclipse-score/docs-as-code.git",
)


Expand Down
Loading