1
# Licensed to the Software Freedom Conservancy (SFC) under one
2
# or more contributor license agreements.  See the NOTICE file
3
# distributed with this work for additional information
4
# regarding copyright ownership.  The SFC licenses this file
5
# to you under the Apache License, Version 2.0 (the
6
# "License"); you may not use this file except in compliance
7
# with the License.  You may obtain a copy of the License at
8
#
9
#   http://www.apache.org/licenses/LICENSE-2.0
10
#
11
# Unless required by applicable law or agreed to in writing,
12
# software distributed under the License is distributed on an
13
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
# KIND, either express or implied.  See the License for the
15
# specific language governing permissions and limitations
16
# under the License.
17

18

19
import os
20
import os.path
21
import sys
22

23
# If extensions (or modules to document with autodoc) are in another directory,
24
# add these directories to sys.path here. If the directory is relative to the
25
# documentation root, use os.path.abspath to make it absolute, like shown here.
26
# sys.path.insert(0, os.path.abspath('.'))
27
sys.path.insert(0, os.path.join(os.getcwd(), "..", ".."))
28

29
# -- General configuration -----------------------------------------------------
30

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

34
# Add any Sphinx extension module names here, as strings. They can be extensions
35
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
36
extensions = [
37
    "sphinx.ext.autodoc",
38
    "sphinx.ext.autosummary",
39
    "sphinx.ext.doctest",
40
    "sphinx.ext.todo",
41
    "sphinx.ext.coverage",
42
    "sphinx.ext.imgmath",
43
    "sphinx.ext.viewcode",
44
]
45

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

49
# The suffix of source filenames.
50
source_suffix = ".rst"
51

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

55
# The master toctree document.
56
master_doc = "index"
57

58
# General information about the project.
59
project = "Selenium"
60
copyright = "2009-2025 Software Freedom Conservancy"
61

62
# The version info for the project you're documenting, acts as replacement for
63
# |version| and |release|, also used in various other places throughout the
64
# built documents.
65
#
66
# The short X.Y version.
67
version = "4.35"
68
# The full version, including alpha/beta/rc tags.
69
release = "4.35.0.202507081456"
70

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

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

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

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

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

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

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

99
# The name of the Pygments (syntax highlighting) style to use.
100
pygments_style = "sphinx"
101

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

105

106
# -- Options for HTML output ---------------------------------------------------
107

108
# The theme to use for HTML and HTML Help pages
109
html_theme = "sphinx_material"
110

111
# Theme options are theme-specific and customize the look and feel of a theme
112
# further.  For a list of options available for each theme, see the
113
# documentation.
114
# html_theme_options = {}
115

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

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

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

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

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

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

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

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

148
# Custom sidebar templates, maps document names to template names.
149
# html_sidebars = {}
150

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

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

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

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

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

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

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

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

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

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

184

185
# -- Options for LaTeX output --------------------------------------------------
186

187
# The paper size ('letter' or 'a4').
188
# latex_paper_size = 'letter'
189

190
# The font size ('10pt', '11pt' or '12pt').
191
# latex_font_size = '10pt'
192

193
# Grouping the document tree into LaTeX files. List of tuples
194
# (source start file, target name, title, author, documentclass [howto/manual]).
195
latex_documents = [
196
    (
197
        "index",
198
        "Selenium.tex",
199
        "Selenium Documentation",
200
        "plightbo, simon.m.stewart, hbchai, jrhuggins, et al.",
201
        "manual",
202
    ),
203
]
204

205
# The name of an image file (relative to this directory) to place at the top of
206
# the title page.
207
# latex_logo = None
208

209
# For "manual" documents, if this is true, then toplevel headings are parts,
210
# not chapters.
211
# latex_use_parts = False
212

213
# If true, show page references after internal links.
214
# latex_show_pagerefs = False
215

216
# If true, show URL addresses after external links.
217
# latex_show_urls = False
218

219
# Additional stuff for the LaTeX preamble.
220
# latex_preamble = ''
221

222
# Documents to append as an appendix to all manuals.
223
# latex_appendices = []
224

225
# If false, no module index is generated.
226
# latex_domain_indices = True
227

228

229
# -- Options for manual page output --------------------------------------------
230

231
# One entry per manual page. List of tuples
232
# (source start file, name, description, authors, manual section).
233
man_pages = [
234
    ("index", "selenium", "Selenium Documentation", ["plightbo, simon.m.stewart, hbchai, jrhuggins, et al."], 1)
235
]
236

237

238
# -- Options for Epub output ---------------------------------------------------
239

240
# Bibliographic Dublin Core info.
241
epub_title = "Selenium"
242
epub_author = "The Selenium Project"
243
epub_publisher = "The Selenium Project"
244
epub_copyright = "2009-2024 Software Freedom Conservancy"
245

246
# The language of the text. It defaults to the language option
247
# or en if the language is not set.
248
# epub_language = ''
249

250
# The scheme of the identifier. Typical schemes are ISBN or URL.
251
# epub_scheme = ''
252

253
# The unique identifier of the text. This can be a ISBN number
254
# or the project homepage.
255
# epub_identifier = ''
256

257
# A unique identification for the text.
258
# epub_uid = ''
259

260
# HTML files that should be inserted before the pages created by sphinx.
261
# The format is a list of tuples containing the path and title.
262
# epub_pre_files = []
263

264
# HTML files that should be inserted after the pages created by sphinx.
265
# The format is a list of tuples containing the path and title.
266
# epub_post_files = []
267

268
# A list of files that should not be packed into the epub file.
269
# epub_exclude_files = []
270

271
# The depth of the table of contents in toc.ncx.
272
# epub_tocdepth = 3
273

274
# Allow duplicate toc entries.
275
# epub_tocdup = True
276

277

278
# Example configuration for intersphinx: refer to the Python standard library.
279
intersphinx_mapping = {"http://docs.python.org/": None}
280

281
# 'members' includes anything that has a docstring, 'undoc-members' includes
282
# functions without docstrings.
283
autodoc_default_flags = ["members", "undoc-members"]
284

285
# configuration for keeping the methods that can be invoked on said classes
286
autodoc_default_options = {
287
    "members": True,
288
    "member-order": "bysource",
289
    "undoc-members": True,
290
    "inherited-members": True,
291
}
292

293
# Include __init__ comments
294
autoclass_content = "both"
295

296