Functions
def	get_libuv_version ()

def	setup (app)

Variables
string	author = 'The gRPC Authors'

dictionary	autodoc_default_options

list	autodoc_mock_imports = []

string	autodoc_typehints = 'description'

bool	autosummary_generate = True

string	branch = 'master'

string	copyright = '2020, The gRPC Authors'

string	epub_author = u'libuv contributors'

string	epub_basename = u'libuv'

string	epub_copyright = u'2014-present, libuv contributors'

list	epub_exclude_files = ['search.html']

string	epub_publisher = u'libuv contributors'

string	epub_title = project

list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

list	extensions

string	html_favicon = 'static/favicon.ico'

list	html_js_files = []

string	html_logo = 'static/logo.png'

string	html_short_title = 'libuv %s documentation' % version

bool	html_show_sourcelink = True

dictionary	html_sidebars

list	html_static_path = ["_static"]

string	html_theme = 'alabaster'

dictionary	html_theme_options

string	html_title = 'libuv documentation'

string	htmlhelp_basename = 'libuv'

dictionary	intersphinx_mapping = {"https://docs.python.org/": None}

string	language = 'en'

list	latex_documents

dictionary	latex_elements

list	man_pages = [(master_doc, 'grpcio', 'grpcio Documentation', [author], 1)]

string	master_doc = 'index'

bool	napoleon_google_docstring = True

bool	napoleon_include_special_with_doc = True

bool	napoleon_numpy_docstring = True

string	project = 'gRPC Python'

	pygments_style = None

	PYTHON_FOLDER

	release = grpc_version.VERSION

string	rst_epilog = '.. \|grpc_types_link\| replace:: https://github.com/grpc/grpc/blob/%s/include/grpc/impl/codegen/grpc_types.h' % branch

list	source_suffix = ['.rst', '.md']

list	templates_path = ['_templates']

list	texinfo_documents

bool	todo_include_todos = True

string	version = '.'.join(grpc_version.VERSION.split('.')[:3])

Function Documentation

◆ get_libuv_version()

def conf.get_libuv_version ( )

Definition at line 20 of file third_party/libuv/docs/src/conf.py.

◆ setup()

def conf.setup ( app )

Definition at line 247 of file third_party/protobuf/python/docs/conf.py.

Variable Documentation

◆ author

string conf.author = 'The gRPC Authors'

Definition at line 32 of file doc/python/sphinx/conf.py.

◆ autodoc_default_options

dictionary conf.autodoc_default_options

Initial value:

 =  {
     'members': None,
 }

Definition at line 67 of file doc/python/sphinx/conf.py.

◆ autodoc_mock_imports

list conf.autodoc_mock_imports = []

Definition at line 71 of file doc/python/sphinx/conf.py.

◆ autodoc_typehints

string conf.autodoc_typehints = 'description'

Definition at line 73 of file doc/python/sphinx/conf.py.

◆ autosummary_generate

bool conf.autosummary_generate = True

Definition at line 235 of file third_party/protobuf/python/docs/conf.py.

◆ branch

string conf.branch = 'master'

Definition at line 39 of file doc/python/sphinx/conf.py.

◆ copyright

string conf.copyright = '2020, The gRPC Authors'

Definition at line 31 of file doc/python/sphinx/conf.py.

◆ epub_author

string conf.epub_author = u'libuv contributors'

Definition at line 285 of file third_party/libuv/docs/src/conf.py.

◆ epub_basename

string conf.epub_basename = u'libuv'

Definition at line 290 of file third_party/libuv/docs/src/conf.py.

◆ epub_copyright

string conf.epub_copyright = u'2014-present, libuv contributors'

Definition at line 287 of file third_party/libuv/docs/src/conf.py.

◆ epub_exclude_files

list conf.epub_exclude_files = ['search.html']

Definition at line 102 of file doc/python/sphinx/conf.py.

◆ epub_publisher

string conf.epub_publisher = u'libuv contributors'

Definition at line 286 of file third_party/libuv/docs/src/conf.py.

◆ epub_title

string conf.epub_title = project

Definition at line 101 of file doc/python/sphinx/conf.py.

◆ exclude_patterns

list conf.exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

Definition at line 49 of file doc/python/sphinx/conf.py.

◆ extensions

list conf.extensions

Initial value:

 =  [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
     'sphinx.ext.todo',
     'sphinx.ext.napoleon',
     'sphinx.ext.coverage',
     'sphinx.ext.autodoc.typehints',
 ]

Definition at line 54 of file doc/python/sphinx/conf.py.

◆ html_favicon

string conf.html_favicon = 'static/favicon.ico'

Definition at line 145 of file third_party/libuv/docs/src/conf.py.

◆ html_js_files

list conf.html_js_files = []

Definition at line 113 of file third_party/protobuf/python/docs/conf.py.

◆ html_logo

string conf.html_logo = 'static/logo.png'

Definition at line 140 of file third_party/libuv/docs/src/conf.py.

◆ html_short_title

string conf.html_short_title = 'libuv %s documentation' % version

Definition at line 136 of file third_party/libuv/docs/src/conf.py.

◆ html_show_sourcelink

bool conf.html_show_sourcelink = True

Definition at line 126 of file third_party/protobuf/python/docs/conf.py.

◆ html_sidebars

dictionary conf.html_sidebars

Initial value:

 =  {
   "**": [
     "globaltoc.html", "localtoc.html", "relations.html", "sourcelink.html",
   ],
 }

Definition at line 137 of file third_party/protobuf/python/docs/conf.py.

◆ html_static_path

list conf.html_static_path = ["_static"]

Definition at line 86 of file doc/python/sphinx/conf.py.

◆ html_theme

string conf.html_theme = 'alabaster'

Definition at line 77 of file doc/python/sphinx/conf.py.

◆ html_theme_options

dictionary conf.html_theme_options

Initial value:

 =  {
     'fixed_sidebar': True,
     'page_width': '1140px',
     'show_related': True,
     'analytics_id': 'UA-60127042-1',
     'description': grpc_version.VERSION,
     'show_powered_by': False,
 }

Definition at line 78 of file doc/python/sphinx/conf.py.

◆ html_title

string conf.html_title = 'libuv documentation'

Definition at line 133 of file third_party/libuv/docs/src/conf.py.

◆ htmlhelp_basename

string conf.htmlhelp_basename = 'libuv'

Definition at line 199 of file third_party/libuv/docs/src/conf.py.

◆ intersphinx_mapping

dictionary conf.intersphinx_mapping = {"https://docs.python.org/": None}

Definition at line 240 of file third_party/protobuf/python/docs/conf.py.

◆ language

conf.language = 'en'

Definition at line 48 of file doc/python/sphinx/conf.py.

◆ latex_documents

list conf.latex_documents

Initial value:

 =  [
   ('index', 'libuv.tex', u'libuv documentation',
    u'libuv contributors', 'manual'),
 ]

Definition at line 218 of file third_party/libuv/docs/src/conf.py.

◆ latex_elements

dictionary conf.latex_elements

Initial value:

 =  {
 # The paper size ('letterpaper' or 'a4paper').
 #'papersize': 'letterpaper',
  
 # The font size ('10pt', '11pt' or '12pt').
 #'pointsize': '10pt',
  
 # Additional stuff for the LaTeX preamble.
 #'preamble': '',
 }

Definition at line 204 of file third_party/libuv/docs/src/conf.py.

◆ man_pages

list conf.man_pages = [(master_doc, 'grpcio', 'grpcio Documentation', [author], 1)]

Definition at line 90 of file doc/python/sphinx/conf.py.

◆ master_doc

string conf.master_doc = 'index'

Definition at line 47 of file doc/python/sphinx/conf.py.

◆ napoleon_google_docstring

bool conf.napoleon_google_docstring = True

Definition at line 63 of file doc/python/sphinx/conf.py.

◆ napoleon_include_special_with_doc

bool conf.napoleon_include_special_with_doc = True

Definition at line 65 of file doc/python/sphinx/conf.py.

◆ napoleon_numpy_docstring

bool conf.napoleon_numpy_docstring = True

Definition at line 64 of file doc/python/sphinx/conf.py.

◆ project

string conf.project = 'gRPC Python'

Definition at line 30 of file doc/python/sphinx/conf.py.

◆ pygments_style

string conf.pygments_style = None

Definition at line 50 of file doc/python/sphinx/conf.py.

◆ PYTHON_FOLDER

conf.PYTHON_FOLDER

Initial value:

1 = os.path.join(os.path.dirname(os.path.realpath(__file__)), '..',

2 '..', '..', 'src', 'python')

Definition at line 19 of file doc/python/sphinx/conf.py.

◆ release

def conf.release = grpc_version.VERSION

Definition at line 37 of file doc/python/sphinx/conf.py.

◆ rst_epilog

string conf.rst_epilog = '.. |grpc_types_link| replace:: https://github.com/grpc/grpc/blob/%s/include/grpc/impl/codegen/grpc_types.h' % branch

Definition at line 110 of file doc/python/sphinx/conf.py.

◆ source_suffix

string conf.source_suffix = ['.rst', '.md']

Definition at line 46 of file doc/python/sphinx/conf.py.

◆ templates_path

list conf.templates_path = ['_templates']

Definition at line 45 of file doc/python/sphinx/conf.py.

◆ texinfo_documents

list conf.texinfo_documents

Initial value:

 =  [
     (master_doc, 'grpcio', 'grpcio Documentation', author, 'grpcio',
      'One line description of project.', 'Miscellaneous'),
 ]

Definition at line 94 of file doc/python/sphinx/conf.py.

◆ todo_include_todos

bool conf.todo_include_todos = True

Definition at line 106 of file doc/python/sphinx/conf.py.

◆ version

string conf.version = '.'.join(grpc_version.VERSION.split('.')[:3])

Definition at line 36 of file doc/python/sphinx/conf.py.

Functions

Variables

Function Documentation

◆ get_libuv_version()

◆ setup()

Variable Documentation

◆ author

◆ autodoc_default_options

◆ autodoc_mock_imports

◆ autodoc_typehints

◆ autosummary_generate

◆ branch

◆ copyright

◆ epub_author

◆ epub_basename

◆ epub_copyright

◆ epub_exclude_files

◆ epub_publisher

◆ epub_title

◆ exclude_patterns

◆ extensions

◆ html_favicon

◆ html_js_files

◆ html_logo

◆ html_short_title

◆ html_show_sourcelink

◆ html_sidebars

◆ html_static_path

◆ html_theme

◆ html_theme_options

◆ html_title

◆ htmlhelp_basename

◆ intersphinx_mapping

◆ language

◆ latex_documents

◆ latex_elements

◆ man_pages

◆ master_doc

◆ napoleon_google_docstring

◆ napoleon_include_special_with_doc

◆ napoleon_numpy_docstring

◆ project

◆ pygments_style

◆ PYTHON_FOLDER

◆ release

◆ rst_epilog

◆ source_suffix

◆ templates_path

◆ texinfo_documents

◆ todo_include_todos

◆ version