feat: optional conf.py - #684
Draft
AlexanderLanin wants to merge 1 commit into
Draft
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //src:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
a-zw
reviewed
Aug 4, 2026
| source_config = ":" + ("" if source_dir == "." else source_dir + "/") + "conf.py" | ||
| config_file_path = join_path(source_dir, "conf.py") | ||
| sphinx_config_for_bazel_build = ":" + config_file_path | ||
| has_source_config = len(native.glob([config_file_path], allow_empty = True)) == 1 |
Contributor
There was a problem hiding this comment.
Could you use the bundle sources instead of globbing yourself again here?
Member
Author
There was a problem hiding this comment.
config.py is not included in the bundle sources
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
2 participants
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.
Motivation: 90-100% of users don't know how changes to conf.py affect documentation build. They assume they can just add code there. While this may be helpful for some quick fixes or workarounds, we need to discourage people from touching the file. As long as the file is there, people will touch it. So let's get rid of the file!
work in progress. 90% done.