feat: optional conf.py - #684
Draft
AlexanderLanin wants to merge 4 commits 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
There was a problem hiding this comment.
Pull request overview
This PR makes conf.py optional for Bazel-driven Sphinx builds by generating a baseline Sphinx configuration from docs() macro attributes, and updates docs/tests to validate the new behavior.
Changes:
- Added
project/project_urltodocs()and implemented generatedconf.pytemplating when no sourceconf.pyexists. - Updated runtime invocation to pass a generated config directory to Sphinx under
bazel run. - Expanded integration tests and documentation to cover “no conf.py” scenarios and the new macro parameters.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/tests/docs_bzl/test_missing_docs_config.py | New negative test asserting analysis fails when neither conf.py nor required macro values are provided |
| src/tests/docs_bzl/test_basic_docs.py | Adds a scenario build test for :needs_json without conf.py |
| src/tests/docs_bzl/scenarios/missing_docs_config/docs/index.rst | Adds scenario documentation content for missing-config fixture |
| src/tests/docs_bzl/scenarios/missing_docs_config/BUILD.negative | Adds negative BUILD fixture omitting project/project_url |
| src/tests/docs_bzl/scenarios/basic_docs/BUILD | Supplies project/project_url for a scenario that has no conf.py |
| src/incremental.py | Supports SPHINX_CONFIG_FILE to pass -c <dir> to Sphinx under bazel run |
| docs/reference/bazel_macros.rst | Documents optional conf.py and required project/project_url when absent |
| docs/how-to/setup.md | Updates setup instructions to make conf.py optional and recommend avoiding it |
| docs/conf.py | Removes the repository’s docs/conf.py |
| docs.bzl | Adds config generation rule, optional macro args, and uses generated config for needs_json; introduces docs alias for CLI |
| default_conf.py.tpl | Adds default generated Sphinx config template parameterized by project metadata |
| BUILD | Exports default_conf.py.tpl and sets project/project_url for the repo’s own docs() invocation |
Comment on lines
+243
to
+246
| # Generate the config at an internal location for ``bazel run`` | ||
| # targets. ``source_dir/conf.py`` would conflict with the generated | ||
| # ``:docs`` executable when source_dir is named ``docs``. | ||
| _generated_conf( |
Comment on lines
+89
to
+92
| Note that conf.py will affect only local builds. It will not affect the integrated | ||
| documentation build by reference_integration. Local builds are useful for testing and | ||
| debugging your documentation before committing changes. Not for final delivery. HAving a | ||
| custom conf.py is highly discouraged. |
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
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.
Note: created downstream PRs in score and persistency. They are unrelated to any of the currently open PRs in docs-as-code.