-
Notifications
You must be signed in to change notification settings - Fork 1.8k
docs(bigquery): fix table rendering in markdown docs #18294
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
Merged
+116
−1
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f3b22ff
docs(bigquery): fix table rendering in markdown docs
shuoweil 319959b
Update packages/google-cloud-bigquery/tests/unit/test_docs.py
shuoweil 34eb197
style: format test_docs.py with black
shuoweil 71354a7
docs: add TODO(b/559711363) in conf.py
shuoweil 36c8df2
test: add unit test for markdown translator monkeypatch
shuoweil 74a6246
docs(bigquery): shorten TODO and refine tests per style guide
shuoweil File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import pathlib | ||
| import runpy | ||
| import sys | ||
| import types | ||
| from unittest import mock | ||
|
|
||
| import pytest | ||
|
|
||
|
|
||
| def test_docs_conf_executes_successfully(): | ||
| docs_dir = pathlib.Path(__file__).parent.parent.parent / "docs" | ||
| conf_path = docs_dir / "conf.py" | ||
| if not conf_path.exists(): | ||
| pytest.skip("docs/conf.py not found") | ||
|
|
||
| res = runpy.run_path(str(conf_path)) | ||
|
shuoweil marked this conversation as resolved.
|
||
|
|
||
| assert res.get("project") == "google-cloud-bigquery" | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def fake_translator_and_mock(): | ||
| docs_dir = pathlib.Path(__file__).parent.parent.parent / "docs" | ||
| conf_path = docs_dir / "conf.py" | ||
| if not conf_path.exists(): | ||
| pytest.skip("docs/conf.py not found") | ||
|
|
||
| mock_orig_depart = mock.MagicMock(return_value="original_output") | ||
|
|
||
| class FakeTranslator: | ||
| depart_paragraph = mock_orig_depart | ||
| depart_compact_paragraph = mock_orig_depart | ||
|
|
||
| fake_module = types.ModuleType("sphinx_markdown_builder.markdown_writer") | ||
| fake_module.MarkdownTranslator = FakeTranslator | ||
|
|
||
| with mock.patch.dict( | ||
| sys.modules, | ||
| { | ||
| "sphinx_markdown_builder": types.ModuleType("sphinx_markdown_builder"), | ||
| "sphinx_markdown_builder.markdown_writer": fake_module, | ||
| }, | ||
| ): | ||
| runpy.run_path(str(conf_path)) | ||
|
|
||
| return FakeTranslator, mock_orig_depart | ||
|
|
||
|
|
||
| def test_depart_paragraph_suppresses_newlines_inside_table_cells( | ||
| fake_translator_and_mock, | ||
| ): | ||
| FakeTranslator, mock_orig_depart = fake_translator_and_mock | ||
| translator = FakeTranslator() | ||
| translator.table_entries = ["cell"] | ||
| node = mock.MagicMock() | ||
|
|
||
| res_paragraph = FakeTranslator.depart_paragraph(translator, node) | ||
| res_compact = FakeTranslator.depart_compact_paragraph(translator, node) | ||
|
|
||
| assert res_paragraph is None | ||
| assert res_compact is None | ||
| mock_orig_depart.assert_not_called() | ||
|
|
||
|
|
||
| def test_depart_paragraph_delegates_outside_table_cells( | ||
| fake_translator_and_mock, | ||
| ): | ||
| FakeTranslator, mock_orig_depart = fake_translator_and_mock | ||
| translator = FakeTranslator() | ||
| node = mock.MagicMock() | ||
|
|
||
| res_paragraph = FakeTranslator.depart_paragraph(translator, node) | ||
| res_compact = FakeTranslator.depart_compact_paragraph(translator, node) | ||
|
|
||
| assert res_paragraph == "original_output" | ||
| assert res_compact == "original_output" | ||
| assert mock_orig_depart.call_count == 2 | ||
| mock_orig_depart.assert_has_calls( | ||
| [ | ||
| mock.call(translator, node), | ||
| mock.call(translator, node), | ||
| ] | ||
| ) | ||
Oops, something went wrong.
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.
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.
Could you provide some details on how this test is covering the changes in
conf.py?Uh oh!
There was an error while loading. Please reload this page.
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.
test_docs.pyis currently a smoke test to verifydocs/conf.pyexecutes without runtime errors and preserves basic configuration.Because documentation dependencies (
sphinx-markdown-builder) are not installed in the unit test environment, the monkeypatch logic is bypassed during unit tests viaexcept ImportError. The formatting fix itself was verified end-to-end usingnox -s docfxby inspecting the generated Markdown (docs/_build/html/docfx_yaml/index.md).I add unit test for markdown translator monkeypatch.