py/docs/source/conf.py - external/github.com/SeleniumHQ/selenium - Git at Google

 # Licensed to the Software Freedom Conservancy (SFC) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
 # regarding copyright ownership.  The SFC licenses this file
 # to you 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 os
 import os.path
 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
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.join(os.getcwd(), "..", ".."))

 # -- General configuration -----------------------------------------------------

 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = '1.0'

 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
 ]

 # Extension configuration.
 autoclass_content = "both"
 autodoc_typehints = "description"
 autodoc_typehints_format = "short"
 autodoc_default_options = {
     "members": True,
     "member-order": "bysource",
     "show-inheritance": True,
     "undoc-members": True,
     "inherited-members": True,
 }
 napoleon_google_docstring = True
 napoleon_numpy_docstring = False

 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

 # The suffix of source filenames.
 source_suffix = ".rst"

 # The encoding of source files.
 # source_encoding = 'utf-8-sig'

 # The master toctree document.
 master_doc = "index"

 # General information about the project.
 project = "Selenium"
 copyright = "Copyright 2004-2011 Selenium committers, 2011-2026 Software Freedom Conservancy"

 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
 version = "4.49"
 # The full version, including alpha/beta/rc tags.
 release = "4.49.0.202608272014"

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None

 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 # today = ''
 # Else, today_fmt is used as the format for a strftime call.
 # today_fmt = '%B %d, %Y'

 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = []

 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None

 # If true, '()' will be appended to :func: etc. cross-reference text.
 # add_function_parentheses = True

 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 add_module_names = False

 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
 # show_authors = False

 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []


 # -- Options for HTML output ---------------------------------------------------

 # The theme to use for HTML and HTML Help pages
 html_theme = "pydata_sphinx_theme"

 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
     "pygments_light_style": "tango",
     "pygments_dark_style": "monokai",
     "primary_sidebar_end": [],
     "show_toc_level": 1,
     "navbar_end": [
         "theme-switcher",
         "navbar-icon-links",
     ],
     "icon_links": [
         {
             "name": "GitHub",
             "url": "https://github.com/SeleniumHQ/selenium",
             "icon": "fa-brands fa-github",
         },
         {
             "name": "PyPI",
             "url": "https://pypi.org/project/selenium",
             "icon": "fa-brands fa-python",
         },
     ],
 }

 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []

 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 # html_title = None

 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None

 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 # html_logo = ''

 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 # html_favicon = None

 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = []

 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 # html_last_updated_fmt = '%b %d, %Y'

 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 # html_use_smartypants = True

 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {
     "**": [],
 }

 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 # html_additional_pages = {}

 # If false, no module index is generated.
 html_domain_indices = True

 # If false, no index is generated.
 html_use_index = True

 # If true, the index is split into individual pages for each letter.
 html_split_index = True

 # If true, links to the reST sources are added to the pages.
 html_show_sourcelink = True

 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 html_show_sphinx = False

 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 # html_show_copyright = True

 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
 # html_use_opensearch = ''

 # This is the file name suffix for HTML files (e.g. ".xhtml").
 # html_file_suffix = None

 # Output file base name for HTML help builder.
 htmlhelp_basename = "Seleniumdoc"
	# Licensed to the Software Freedom Conservancy (SFC) under one
	# or more contributor license agreements. See the NOTICE file
	# distributed with this work for additional information
	# regarding copyright ownership. The SFC licenses this file
	# to you 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 os
	import os.path
	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
	# documentation root, use os.path.abspath to make it absolute, like shown here.
	# sys.path.insert(0, os.path.abspath('.'))
	sys.path.insert(0, os.path.join(os.getcwd(), "..", ".."))

	# -- General configuration -----------------------------------------------------

	# If your documentation needs a minimal Sphinx version, state it here.
	# needs_sphinx = '1.0'

	# Add any Sphinx extension module names here, as strings. They can be extensions
	# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
	extensions = [
	"sphinx.ext.autodoc",
	"sphinx.ext.autosummary",
	"sphinx.ext.napoleon",
	"sphinx.ext.viewcode",
	]

	# Extension configuration.
	autoclass_content = "both"
	autodoc_typehints = "description"
	autodoc_typehints_format = "short"
	autodoc_default_options = {
	"members": True,
	"member-order": "bysource",
	"show-inheritance": True,
	"undoc-members": True,
	"inherited-members": True,
	}
	napoleon_google_docstring = True
	napoleon_numpy_docstring = False

	# Add any paths that contain templates here, relative to this directory.
	templates_path = ["_templates"]

	# The suffix of source filenames.
	source_suffix = ".rst"

	# The encoding of source files.
	# source_encoding = 'utf-8-sig'

	# The master toctree document.
	master_doc = "index"

	# General information about the project.
	project = "Selenium"
	copyright = "Copyright 2004-2011 Selenium committers, 2011-2026 Software Freedom Conservancy"

	# The version info for the project you're documenting, acts as replacement for
	# \|version\| and \|release\|, also used in various other places throughout the
	# built documents.
	#
	# The short X.Y version.
	version = "4.49"
	# The full version, including alpha/beta/rc tags.
	release = "4.49.0.202608272014"

	# The language for content autogenerated by Sphinx. Refer to documentation
	# for a list of supported languages.
	# language = None

	# There are two options for replacing \|today\|: either, you set today to some
	# non-false value, then it is used:
	# today = ''
	# Else, today_fmt is used as the format for a strftime call.
	# today_fmt = '%B %d, %Y'

	# List of patterns, relative to source directory, that match files and
	# directories to ignore when looking for source files.
	exclude_patterns = []

	# The reST default role (used for this markup: `text`) to use for all documents.
	# default_role = None

	# If true, '()' will be appended to :func: etc. cross-reference text.
	# add_function_parentheses = True

	# If true, the current module name will be prepended to all description
	# unit titles (such as .. function::).
	add_module_names = False

	# If true, sectionauthor and moduleauthor directives will be shown in the
	# output. They are ignored by default.
	# show_authors = False

	# A list of ignored prefixes for module index sorting.
	# modindex_common_prefix = []


	# -- Options for HTML output ---------------------------------------------------

	# The theme to use for HTML and HTML Help pages
	html_theme = "pydata_sphinx_theme"

	# Theme options are theme-specific and customize the look and feel of a theme
	# further. For a list of options available for each theme, see the
	# documentation.
	html_theme_options = {
	"pygments_light_style": "tango",
	"pygments_dark_style": "monokai",
	"primary_sidebar_end": [],
	"show_toc_level": 1,
	"navbar_end": [
	"theme-switcher",
	"navbar-icon-links",
	],
	"icon_links": [
	{
	"name": "GitHub",
	"url": "https://github.com/SeleniumHQ/selenium",
	"icon": "fa-brands fa-github",
	},
	{
	"name": "PyPI",
	"url": "https://pypi.org/project/selenium",
	"icon": "fa-brands fa-python",
	},
	],
	}

	# Add any paths that contain custom themes here, relative to this directory.
	# html_theme_path = []

	# The name for this set of Sphinx documents. If None, it defaults to
	# "<project> v<release> documentation".
	# html_title = None

	# A shorter title for the navigation bar. Default is the same as html_title.
	# html_short_title = None

	# The name of an image file (relative to this directory) to place at the top
	# of the sidebar.
	# html_logo = ''

	# The name of an image file (within the static path) to use as favicon of the
	# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
	# pixels large.
	# html_favicon = None

	# Add any paths that contain custom static files (such as style sheets) here,
	# relative to this directory. They are copied after the builtin static files,
	# so a file named "default.css" will overwrite the builtin "default.css".
	html_static_path = []

	# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
	# using the given strftime format.
	# html_last_updated_fmt = '%b %d, %Y'

	# If true, SmartyPants will be used to convert quotes and dashes to
	# typographically correct entities.
	# html_use_smartypants = True

	# Custom sidebar templates, maps document names to template names.
	html_sidebars = {
	"**": [],
	}

	# Additional templates that should be rendered to pages, maps page names to
	# template names.
	# html_additional_pages = {}

	# If false, no module index is generated.
	html_domain_indices = True

	# If false, no index is generated.
	html_use_index = True

	# If true, the index is split into individual pages for each letter.
	html_split_index = True

	# If true, links to the reST sources are added to the pages.
	html_show_sourcelink = True

	# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
	html_show_sphinx = False

	# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
	# html_show_copyright = True

	# If true, an OpenSearch description file will be output, and all pages will
	# contain a <link> tag referring to it. The value of this option must be the
	# base URL from which the finished HTML is served.
	# html_use_opensearch = ''

	# This is the file name suffix for HTML files (e.g. ".xhtml").
	# html_file_suffix = None

	# Output file base name for HTML help builder.
	htmlhelp_basename = "Seleniumdoc"