codekingpro/portable-devtools

1# -*- coding: utf-8 -*-2# Copyright 2023 Google LLC3#4# Licensed under the Apache License, Version 2.0 (the "License");5# you may not use this file except in compliance with the License.6# You may obtain a copy of the License at7#8# http://www.apache.org/licenses/LICENSE-2.09#10# Unless required by applicable law or agreed to in writing, software11# distributed under the License is distributed on an "AS IS" BASIS,12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.13# See the License for the specific language governing permissions and14# limitations under the License.15#16# google-auth-oauthlib documentation build configuration file17#18# This file is execfile()d with the current directory set to its19# containing dir.20#21# Note that not all possible configuration values are present in this22# autogenerated file.23#24# All configuration values have a default; values that are commented out25# serve to show the default.26 27import sys28import os29import shlex30 31# If extensions (or modules to document with autodoc) are in another directory,32# add these directories to sys.path here. If the directory is relative to the33# documentation root, use os.path.abspath to make it absolute, like shown here.34sys.path.insert(0, os.path.abspath(".."))35 36# For plugins that can not read conf.py.37# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/8538sys.path.insert(0, os.path.abspath("."))39 40__version__ = ""41 42# -- General configuration ------------------------------------------------43 44# If your documentation needs a minimal Sphinx version, state it here.45needs_sphinx = "1.5.5"46 47# Add any Sphinx extension module names here, as strings. They can be48# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom49# ones.50extensions = [51    "sphinx.ext.autodoc",52    "sphinx.ext.autosummary",53    "sphinx.ext.intersphinx",54    "sphinx.ext.coverage",55    "sphinx.ext.doctest",56    "sphinx.ext.napoleon",57    "sphinx.ext.todo",58    "sphinx.ext.viewcode",59    "recommonmark",60]61 62# autodoc/autosummary flags63autoclass_content = "both"64autodoc_default_options = {"members": True}65autosummary_generate = True66 67 68# Add any paths that contain templates here, relative to this directory.69templates_path = ["_templates"]70 71# The suffix(es) of source filenames.72# You can specify multiple suffix as a list of string:73# source_suffix = ['.rst', '.md']74source_suffix = [".rst", ".md"]75 76# The encoding of source files.77# source_encoding = 'utf-8-sig'78 79# The root toctree document.80root_doc = "index"81 82# General information about the project.83project = "google-auth-oauthlib"84copyright = "2019, Google"85author = "Google APIs"86 87# The version info for the project you're documenting, acts as replacement for88# |version| and |release|, also used in various other places throughout the89# built documents.90#91# The full version, including alpha/beta/rc tags.92release = __version__93# The short X.Y version.94version = ".".join(release.split(".")[0:2])95 96# The language for content autogenerated by Sphinx. Refer to documentation97# for a list of supported languages.98#99# This is also used if you do content translation via gettext catalogs.100# Usually you set "language" from the command line for these cases.101language = None102 103# There are two options for replacing |today|: either, you set today to some104# non-false value, then it is used:105# today = ''106# Else, today_fmt is used as the format for a strftime call.107# today_fmt = '%B %d, %Y'108 109# List of patterns, relative to source directory, that match files and110# directories to ignore when looking for source files.111exclude_patterns = [112    "_build",113    "**/.nox/**/*",114    "samples/AUTHORING_GUIDE.md",115    "samples/CONTRIBUTING.md",116    "samples/snippets/README.rst",117]118 119# The reST default role (used for this markup: `text`) to use for all120# documents.121# default_role = None122 123# If true, '()' will be appended to :func: etc. cross-reference text.124# add_function_parentheses = True125 126# If true, the current module name will be prepended to all description127# unit titles (such as .. function::).128# add_module_names = True129 130# If true, sectionauthor and moduleauthor directives will be shown in the131# output. They are ignored by default.132# show_authors = False133 134# The name of the Pygments (syntax highlighting) style to use.135pygments_style = "sphinx"136 137# A list of ignored prefixes for module index sorting.138# modindex_common_prefix = []139 140# If true, keep warnings as "system message" paragraphs in the built documents.141# keep_warnings = False142 143# If true, `todo` and `todoList` produce output, else they produce nothing.144todo_include_todos = True145 146 147# -- Options for HTML output ----------------------------------------------148 149# The theme to use for HTML and HTML Help pages.  See the documentation for150# a list of builtin themes.151html_theme = "alabaster"152 153# Theme options are theme-specific and customize the look and feel of a theme154# further.  For a list of options available for each theme, see the155# documentation.156html_theme_options = {157    "description": "Google Cloud Client Libraries for google-auth-oauthlib",158    "github_user": "googleapis",159    "github_repo": "google-auth-library-python-oauthlib",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",164}165 166# Add any paths that contain custom themes here, relative to this directory.167# html_theme_path = []168 169# The name for this set of Sphinx documents.  If None, it defaults to170# "<project> v<release> documentation".171# html_title = None172 173# A shorter title for the navigation bar.  Default is the same as html_title.174# html_short_title = None175 176# The name of an image file (relative to this directory) to place at the top177# of the sidebar.178# html_logo = None179 180# The name of an image file (within the static path) to use as favicon of the181# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32182# pixels large.183# html_favicon = None184 185# Add any paths that contain custom static files (such as style sheets) here,186# relative to this directory. They are copied after the builtin static files,187# so a file named "default.css" will overwrite the builtin "default.css".188html_static_path = ["_static"]189 190# Add any extra paths that contain custom files (such as robots.txt or191# .htaccess) here, relative to this directory. These files are copied192# directly to the root of the documentation.193# html_extra_path = []194 195# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,196# using the given strftime format.197# html_last_updated_fmt = '%b %d, %Y'198 199# If true, SmartyPants will be used to convert quotes and dashes to200# typographically correct entities.201# html_use_smartypants = True202 203# Custom sidebar templates, maps document names to template names.204# html_sidebars = {}205 206# Additional templates that should be rendered to pages, maps page names to207# template names.208# html_additional_pages = {}209 210# If false, no module index is generated.211# html_domain_indices = True212 213# If false, no index is generated.214# html_use_index = True215 216# If true, the index is split into individual pages for each letter.217# html_split_index = False218 219# If true, links to the reST sources are added to the pages.220# html_show_sourcelink = True221 222# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.223# html_show_sphinx = True224 225# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.226# html_show_copyright = True227 228# If true, an OpenSearch description file will be output, and all pages will229# contain a <link> tag referring to it.  The value of this option must be the230# base URL from which the finished HTML is served.231# html_use_opensearch = ''232 233# This is the file name suffix for HTML files (e.g. ".xhtml").234# html_file_suffix = None235 236# Language to be used for generating the HTML full-text search index.237# Sphinx supports the following languages:238#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'239#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'240# html_search_language = 'en'241 242# A dictionary with options for the search language support, empty by default.243# Now only 'ja' uses this config value244# html_search_options = {'type': 'default'}245 246# The name of a javascript file (relative to the configuration directory) that247# implements a search results scorer. If empty, the default will be used.248# html_search_scorer = 'scorer.js'249 250# Output file base name for HTML help builder.251htmlhelp_basename = "google-auth-oauthlib-doc"252 253# -- Options for warnings ------------------------------------------------------254 255 256suppress_warnings = [257    # Temporarily suppress this to avoid "more than one target found for258    # cross-reference" warning, which are intractable for us to avoid while in259    # a mono-repo.260    # See https://github.com/sphinx-doc/sphinx/blob261    # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843262    "ref.python"263]264 265# -- Options for LaTeX output ---------------------------------------------266 267latex_elements = {268    # The paper size ('letterpaper' or 'a4paper').269    #'papersize': 'letterpaper',270    # The font size ('10pt', '11pt' or '12pt').271    #'pointsize': '10pt',272    # Additional stuff for the LaTeX preamble.273    #'preamble': '',274    # Latex figure (float) alignment275    #'figure_align': 'htbp',276}277 278# Grouping the document tree into LaTeX files. List of tuples279# (source start file, target name, title,280#  author, documentclass [howto, manual, or own class]).281latex_documents = [282    (283        root_doc,284        "google-auth-oauthlib.tex",285        "google-auth-oauthlib Documentation",286        author,287        "manual",288    )289]290 291# The name of an image file (relative to this directory) to place at the top of292# the title page.293# latex_logo = None294 295# For "manual" documents, if this is true, then toplevel headings are parts,296# not chapters.297# latex_use_parts = False298 299# If true, show page references after internal links.300# latex_show_pagerefs = False301 302# If true, show URL addresses after external links.303# latex_show_urls = False304 305# Documents to append as an appendix to all manuals.306# latex_appendices = []307 308# If false, no module index is generated.309# latex_domain_indices = True310 311 312# -- Options for manual page output ---------------------------------------313 314# One entry per manual page. List of tuples315# (source start file, name, description, authors, manual section).316man_pages = [317    (318        root_doc,319        "google-auth-oauthlib",320        "google-auth-oauthlib Documentation",321        [author],322        1,323    )324]325 326# If true, show URL addresses after external links.327# man_show_urls = False328 329 330# -- Options for Texinfo output -------------------------------------------331 332# Grouping the document tree into Texinfo files. List of tuples333# (source start file, target name, title, author,334#  dir menu entry, description, category)335texinfo_documents = [336    (337        root_doc,338        "google-auth-oauthlib",339        "google-auth-oauthlib Documentation",340        author,341        "google-auth-oauthlib",342        "google-auth-oauthlib Library",343        "APIs",344    )345]346 347# Documents to append as an appendix to all manuals.348# texinfo_appendices = []349 350# If false, no module index is generated.351# texinfo_domain_indices = True352 353# How to display URL addresses: 'footnote', 'no', or 'inline'.354# texinfo_show_urls = 'footnote'355 356# If true, do not generate a @detailmenu in the "Top" node's menu.357# texinfo_no_detailmenu = False358 359 360# Example configuration for intersphinx: refer to the Python standard library.361intersphinx_mapping = {362    "python": ("https://python.readthedocs.org/en/latest/", None),363    "google-auth": ("https://googleapis.dev/python/google-auth/latest/", None),364    "google.api_core": (365        "https://googleapis.dev/python/google-api-core/latest/",366        None,367    ),368    "grpc": ("https://grpc.github.io/grpc/python/", None),369    "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None),370    "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None),371}372 373 374# Napoleon settings375napoleon_google_docstring = True376napoleon_numpy_docstring = True377napoleon_include_private_with_doc = False378napoleon_include_special_with_doc = True379napoleon_use_admonition_for_examples = False380napoleon_use_admonition_for_notes = False381napoleon_use_admonition_for_references = False382napoleon_use_ivar = False383napoleon_use_param = True384napoleon_use_rtype = True385