Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 21 additions & 1 deletion packages/google-cloud-bigquery/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import shlex
import sys

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand All @@ -37,6 +37,26 @@
# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/85
sys.path.insert(0, os.path.abspath("."))

# sphinx-markdown-builder unconditionally inserts trailing newlines into
# table cell paragraphs, breaking DevSite table formatting. Suppressing
# newlines while inside table cells preserves valid GFM tables.
try:
import sphinx_markdown_builder.markdown_writer as _smb_writer

_orig_depart_paragraph = _smb_writer.MarkdownTranslator.depart_paragraph

def _table_safe_depart_paragraph(self, node):
if getattr(self, "table_entries", None):
return
return _orig_depart_paragraph(self, node)

_smb_writer.MarkdownTranslator.depart_paragraph = _table_safe_depart_paragraph
_smb_writer.MarkdownTranslator.depart_compact_paragraph = (
_table_safe_depart_paragraph
)
except ImportError:
pass

__version__ = ""

# -- General configuration ------------------------------------------------
Expand Down
31 changes: 31 additions & 0 deletions packages/google-cloud-bigquery/tests/unit/test_docs.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 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


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():
import pytest

pytest.skip("docs/conf.py not found")

res = runpy.run_path(str(conf_path))
Comment thread
shuoweil marked this conversation as resolved.

assert "project" in res
assert res["project"] == "google-cloud-bigquery"
Loading