1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
import os
import sys
# Set up Python environment to load build system packages.
OUR_DIR = os.path.dirname(__file__)
topsrcdir = os.path.normpath(os.path.join(OUR_DIR, ".."))
# Escapes $, [, ] and 3 dots in copy button
copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
copybutton_prompt_is_regexp = True
EXTRA_PATHS = (
"layout/tools/reftest",
"python/mach",
"python/mozbuild",
"python/mozversioncontrol",
"testing/mozbase/manifestparser",
"testing/mozbase/mozfile",
"testing/mozbase/mozprocess",
"testing/mozbase/moznetwork",
"third_party/python/jsmin",
"third_party/python/which",
"docs/_addons",
"taskcluster/gecko_taskgraph/test",
)
sys.path[:0] = [os.path.join(topsrcdir, p) for p in EXTRA_PATHS]
sys.path.insert(0, OUR_DIR)
extensions = [
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.autosectionlabel",
"sphinx.ext.doctest",
"sphinx.ext.graphviz",
"sphinx.ext.napoleon",
"sphinx.ext.todo",
"mozbuild.sphinx",
"sphinx_js",
"sphinxcontrib.jquery",
"sphinxcontrib.mermaid",
"sphinx_copybutton",
"sphinx_markdown_tables",
"sphinx_design",
"bzlink",
]
myst_enable_extensions = [
"colon_fence",
"smartquotes",
"deflist",
"html_admonition",
"fieldlist",
]
# JSDoc must run successfully for dirs specified, so running
# tree-wide (the default) will not work currently.
# When adding more paths to this list, please ensure that they are not
# excluded from the valid-jsdoc and require-jsdoc sections in the top-level
# eslint-rollouts.config.mjs.
js_source_path = [
"../browser/components/backup",
"../browser/components/backup/actors",
"../browser/components/backup/resources",
"../browser/components/customizableui",
"../browser/components/extensions",
"../browser/components/migration",
"../browser/components/migration/content",
"../browser/components/mozcachedohttp",
"../browser/components/mozcachedohttp/actors",
"../browser/components/uitour",
"../browser/components/urlbar",
"../js/xpconnect/loader",
"../remote/marionette",
"../testing/mochitest/BrowserTestUtils",
"../testing/mochitest/tests/SimpleTest/SimpleTest.js",
"../testing/mochitest/tests/SimpleTest/EventUtils.js",
"../testing/modules/Assert.sys.mjs",
"../testing/modules/TestUtils.sys.mjs",
"../toolkit/actors",
"../toolkit/components/extensions",
"../toolkit/components/extensions/parent",
"../toolkit/components/ml/content/backends/ONNXPipeline.mjs",
"../toolkit/modules/BrowserUtils.sys.mjs",
"../toolkit/mozapps/extensions",
"../toolkit/components/prompts/src",
"../toolkit/components/pictureinpicture",
"../toolkit/components/pictureinpicture/content",
# This is limited to SearchService.sys.mjs for now, as we only need to
# generate docs for that file currently. Other search files
# (e.g. SearchEngineSelector) are failing due to
# https://github.com/pyodide/sphinx-js/issues/242 or a variant of it.
"../toolkit/components/search/SearchService.sys.mjs",
"../toolkit/components/uniffi-bindgen-gecko-js/components/generated",
]
root_for_relative_js_paths = ".."
jsdoc_config_path = "jsdoc.json"
templates_path = ["_templates"]
source_suffix = [".rst", ".md"]
master_doc = "index"
project = "Firefox Source Docs"
# Override the search box to use Google instead of
# sphinx search on firefox-source-docs.mozilla.org
if (
os.environ.get("MOZ_SOURCE_DOCS_USE_GOOGLE") == "1"
and os.environ.get("MOZ_SCM_LEVEL") == "3"
):
templates_path.append("_search_template")
html_sidebars = {
"**": [
"searchbox.html",
]
}
html_logo = os.path.join(
topsrcdir, "browser/branding/nightly/content/firefox-wordmark.svg"
)
html_favicon = os.path.join(topsrcdir, "browser/branding/nightly/firefox.ico")
exclude_patterns = ["_build", "_staging", "_venv", "**security/nss/legacy/**"]
pygments_style = "sphinx"
# generate label “slugs” for header anchors so that
# we can reference them from markdown links.
myst_heading_anchors = 5
# We need to perform some adjustment of the settings and environment
# when running on Read The Docs.
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
if on_rtd:
# SHELL isn't set on RTD and mach.mixin.process's import raises if a
# shell-related environment variable can't be found. Set the variable here
# to hack us into working on RTD.
assert "SHELL" not in os.environ
os.environ["SHELL"] = "/bin/bash"
else:
# We only need to set the RTD theme when not on RTD because the RTD
# environment handles this otherwise.
html_theme = "sphinx_rtd_theme"
# As we parse the error messages and they can be translated, force
# the english locale
os.environ["LANG"] = "C"
html_static_path = ["_static"]
htmlhelp_basename = "FirefoxTreeDocs"
moz_project_name = "main"
html_show_copyright = False
# Only run autosection for the page title.
# Otherwise, we have a huge number of duplicate links.
# For example, the page https://firefox-source-docs.mozilla.org/code-quality/lint/
# is called "Linting"
# just like https://firefox-source-docs.mozilla.org/remote/CodeStyle.html
autosectionlabel_maxdepth = 1
def install_sphinx_design(app, pagename, templatename, context, doctree):
if "perfdocs" in pagename:
app.add_js_file("sphinx_design.js")
app.add_css_file("sphinx_design.css")
def setup(app):
app.add_css_file("custom_theme.css")
app.connect("html-page-context", install_sphinx_design)
|
