Skip to content

Exclude baselibs' cpp-style-guide.md from aggregated docs #347

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

Open
antonkri wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Exclude baselibs' cpp-style-guide.md from aggregated docs #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57a92e9
Exclude baselibs' cpp-style-guide.md from aggregated docs instead of …
antonkri Sep 16, 2026
412212f
Revert: restore cpp-style-guide toctree patch
antonkri Sep 16, 2026
91e750c
Exclude baselibs' cpp-style-guide.md via docs/.ignore instead of a to…
antonkri Sep 16, 2026
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
2 changes: 1 addition & 1 deletion bazel_common/score_modules_target_sw.MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ git_override(
"//patches/baselibs:001-restore-trace-library-mock-visibility.patch",
"//patches/baselibs:002-restore-qnx8-poll-workaround.patch",
"//patches/baselibs:005-rename-manual-verification-report-id.patch",
"//patches/baselibs:006-include-cpp-style-guide-in-toctree.patch",
"//patches/baselibs:006-exclude-cpp-style-guide-from-docs-mount.patch",
],
remote = "https://github.com/eclipse-score/baselibs.git",
)
Expand Down
2 changes: 1 addition & 1 deletion known_good.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"//patches/baselibs:001-restore-trace-library-mock-visibility.patch",
"//patches/baselibs:002-restore-qnx8-poll-workaround.patch",
"//patches/baselibs:005-rename-manual-verification-report-id.patch",
"//patches/baselibs:006-include-cpp-style-guide-in-toctree.patch"
"//patches/baselibs:006-exclude-cpp-style-guide-from-docs-mount.patch"
],
"metadata": {
"code_root_path": "//score/...",
Expand Down
12 changes: 12 additions & 0 deletions patches/baselibs/006-exclude-cpp-style-guide-from-docs-mount.patch
View file
Open in desktop

@PiotrKorkus PiotrKorkus Sep 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

if baselibs is also excluding this file from their docs build and previous exclude_pattern approach was not working here in ref_int - should this ignore file be located in baselibs itself and we wont need to do the patch here?
I assume both solutions have exactly the same outcome or?

@antonkri antonkri Sep 16, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hey @PiotrKorkus ,

I've checked it once again, I guess, with the new approach the file/page is away. Baselibs ignore this file in conf.py. Putting the same in the ref_int will not work because of the bundles approach (that's what copilot says).

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
diff --git a/docs/.ignore b/docs/.ignore
new file mode 100644
--- /dev/null
+++ b/docs/.ignore
@@ -0,0 +1,7 @@
+# reference_integration mounts this directory into its aggregated docs
+# build via sphinx_mounts, which walks it independently of Sphinx's own
+# exclude_patterns. baselibs' own docs/conf.py already excludes this file
+# from baselibs' native docs build; mirror that here so it stays excluded
+# from the aggregated build too, instead of only being reachable through a
+# toctree link added solely for reference_integration's benefit.
+cpp-style-guide.md
20 changes: 0 additions & 20 deletions patches/baselibs/006-include-cpp-style-guide-in-toctree.patch
View file
Open in desktop

This file was deleted.

Loading