|
24 | 24 | # All configuration values have a default; values that are commented out |
25 | 25 | # serve to show the default. |
26 | 26 |
|
27 | | -from __future__ import annotations |
28 | | - |
29 | 27 | import os |
| 28 | +import shlex |
30 | 29 | import sys |
31 | | -from typing import Any |
32 | 30 |
|
33 | 31 | # If extensions (or modules to document with autodoc) are in another directory, |
34 | 32 | # add these directories to sys.path here. If the directory is relative to the |
|
58 | 56 | "sphinx.ext.napoleon", |
59 | 57 | "sphinx.ext.todo", |
60 | 58 | "sphinx.ext.viewcode", |
61 | | - "myst_parser", |
| 59 | + "recommonmark", |
62 | 60 | ] |
63 | 61 |
|
64 | 62 | # autodoc/autosummary flags |
|
100 | 98 | # |
101 | 99 | # This is also used if you do content translation via gettext catalogs. |
102 | 100 | # Usually you set "language" from the command line for these cases. |
103 | | -language = "en-US" |
| 101 | +language = None |
104 | 102 |
|
105 | 103 | # There are two options for replacing |today|: either, you set today to some |
106 | 104 | # non-false value, then it is used: |
|
150 | 148 |
|
151 | 149 | # The theme to use for HTML and HTML Help pages. See the documentation for |
152 | 150 | # a list of builtin themes. |
153 | | -html_theme = "pydata_sphinx_theme" |
| 151 | +html_theme = "alabaster" |
154 | 152 |
|
155 | 153 | # Theme options are theme-specific and customize the look and feel of a theme |
156 | 154 | # further. For a list of options available for each theme, see the |
157 | 155 | # documentation. |
158 | | -# https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#references |
159 | 156 | html_theme_options = { |
160 | | - "github_url": "https://github.com/googleapis/python-bigquery-dataframes", |
161 | | - "logo": { |
162 | | - "text": "BigQuery DataFrames (BigFrames)", |
163 | | - }, |
164 | | - "external_links": [ |
165 | | - { |
166 | | - "name": "Getting started", |
167 | | - "url": "https://docs.cloud.google.com/bigquery/docs/dataframes-quickstart", |
168 | | - }, |
169 | | - { |
170 | | - "name": "User guide", |
171 | | - "url": "https://docs.cloud.google.com/bigquery/docs/bigquery-dataframes-introduction", |
172 | | - }, |
173 | | - ], |
| 157 | + "description": "BigQuery DataFrames provides DataFrame APIs on the BigQuery engine", |
| 158 | + "github_user": "googleapis", |
| 159 | + "github_repo": "python-bigquery-dataframes", |
| 160 | + "github_banner": True, |
| 161 | + "font_family": "'Roboto', Georgia, sans", |
| 162 | + "head_font_family": "'Roboto', Georgia, serif", |
| 163 | + "code_font_family": "'Roboto Mono', 'Consolas', monospace", |
174 | 164 | } |
175 | 165 |
|
176 | 166 | # Add any paths that contain custom themes here, relative to this directory. |
|
274 | 264 |
|
275 | 265 | # -- Options for LaTeX output --------------------------------------------- |
276 | 266 |
|
277 | | -latex_elements: dict[str, Any] = { |
| 267 | +latex_elements = { |
278 | 268 | # The paper size ('letterpaper' or 'a4paper'). |
279 | 269 | #'papersize': 'letterpaper', |
280 | 270 | # The font size ('10pt', '11pt' or '12pt'). |
|
292 | 282 | ( |
293 | 283 | root_doc, |
294 | 284 | "bigframes.tex", |
295 | | - "BigQuery DataFrames (BigFrames)", |
| 285 | + "bigframes Documentation", |
296 | 286 | author, |
297 | 287 | "manual", |
298 | 288 | ) |
|
327 | 317 | ( |
328 | 318 | root_doc, |
329 | 319 | "bigframes", |
330 | | - "BigQuery DataFrames (BigFrames)", |
| 320 | + "bigframes Documentation", |
331 | 321 | [author], |
332 | 322 | 1, |
333 | 323 | ) |
|
346 | 336 | ( |
347 | 337 | root_doc, |
348 | 338 | "bigframes", |
349 | | - "BigQuery DataFrames (BigFrames)", |
| 339 | + "bigframes Documentation", |
350 | 340 | author, |
351 | 341 | "bigframes", |
352 | 342 | "bigframes Library", |
|
0 commit comments