|
25 | 25 | # -- General configuration ------------------------------------------------
|
26 | 26 |
|
27 | 27 | # If your documentation needs a minimal Sphinx version, state it here.
|
28 |
| -# needs_sphinx = '1.0' |
| 28 | +needs_sphinx = "1.6.3" |
29 | 29 |
|
30 | 30 | # Add any Sphinx extension module names here, as strings. They can be
|
31 | 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
36 | 36 | "sphinx.ext.intersphinx",
|
37 | 37 | "sphinx.ext.coverage",
|
38 | 38 | "sphinx.ext.napoleon",
|
| 39 | + "sphinx.ext.todo", |
39 | 40 | "sphinx.ext.viewcode",
|
40 | 41 | ]
|
41 | 42 |
|
|
47 | 48 | # Add any paths that contain templates here, relative to this directory.
|
48 | 49 | templates_path = ["_templates"]
|
49 | 50 |
|
| 51 | +# Allow markdown includes (so releases.md can include CHANGLEOG.md) |
| 52 | +# http://www.sphinx-doc.org/en/master/markdown.html |
| 53 | +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} |
| 54 | + |
50 | 55 | # The suffix(es) of source filenames.
|
51 | 56 | # You can specify multiple suffix as a list of string:
|
52 | 57 | # source_suffix = ['.rst', '.md']
|
53 |
| -source_suffix = ".rst" |
| 58 | +source_suffix = [".rst", ".md"] |
54 | 59 |
|
55 | 60 | # The encoding of source files.
|
56 | 61 | # source_encoding = 'utf-8-sig'
|
|
120 | 125 |
|
121 | 126 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
122 | 127 | # a list of builtin themes.
|
123 |
| -html_theme = "sphinx_rtd_theme" |
| 128 | +html_theme = "alabaster" |
124 | 129 |
|
125 | 130 | # Theme options are theme-specific and customize the look and feel of a theme
|
126 | 131 | # further. For a list of options available for each theme, see the
|
127 | 132 | # documentation.
|
128 |
| -# html_theme_options = {} |
| 133 | +html_theme_options = { |
| 134 | + "description": "Google Cloud Client Libraries for Python", |
| 135 | + "github_user": "googleapis", |
| 136 | + "github_repo": "google-cloud-python", |
| 137 | + "github_banner": True, |
| 138 | + "font_family": "'Roboto', Georgia, sans", |
| 139 | + "head_font_family": "'Roboto', Georgia, serif", |
| 140 | + "code_font_family": "'Roboto Mono', 'Consolas', monospace", |
| 141 | +} |
129 | 142 |
|
130 | 143 | # Add any paths that contain custom themes here, relative to this directory.
|
131 | 144 | # html_theme_path = []
|
|
214 | 227 | # Output file base name for HTML help builder.
|
215 | 228 | htmlhelp_basename = "google-cloud-dlp-doc"
|
216 | 229 |
|
| 230 | +# -- Options for warnings ------------------------------------------------------ |
| 231 | + |
| 232 | +suppress_warnings = [ |
| 233 | + # Temporarily suppress this to avoid "more than one target found for |
| 234 | + # cross-reference" warning, which are intractable for us to avoid while in |
| 235 | + # a mono-repo. |
| 236 | + # See https://github.com/sphinx-doc/sphinx/blob |
| 237 | + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 |
| 238 | + "ref.python" |
| 239 | +] |
| 240 | + |
217 | 241 | # -- Options for LaTeX output ---------------------------------------------
|
218 | 242 |
|
219 | 243 | latex_elements = {
|
|
304 | 328 | intersphinx_mapping = {
|
305 | 329 | "python": ("http://python.readthedocs.org/en/latest/", None),
|
306 | 330 | "gax": ("https://gax-python.readthedocs.org/en/latest/", None),
|
| 331 | + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), |
| 332 | + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), |
| 333 | + "google.api_core": ( |
| 334 | + "https://googleapis.github.io/google-cloud-python/latest", |
| 335 | + None, |
| 336 | + ), |
| 337 | + "grpc": ("https://grpc.io/grpc/python/", None), |
| 338 | + "requests": ("http://docs.python-requests.org/en/master/", None), |
| 339 | + "fastavro": ("https://fastavro.readthedocs.io/en/stable/", None), |
| 340 | + "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None), |
307 | 341 | }
|
308 | 342 |
|
309 | 343 | # Napoleon settings
|
|
0 commit comments