1 # This Source Code Form is subject to the terms of the Mozilla Public
2 # License, v. 2.0. If a copy of the MPL was not distributed with this
3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 # Set up Python environment to load build system packages.
9 OUR_DIR
= os
.path
.dirname(__file__
)
10 topsrcdir
= os
.path
.normpath(os
.path
.join(OUR_DIR
, ".."))
12 # Escapes $, [, ] and 3 dots in copy button
13 copybutton_prompt_text
= r
">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
14 copybutton_prompt_is_regexp
= True
17 "layout/tools/reftest",
20 "python/mozversioncontrol",
21 "testing/mozbase/manifestparser",
22 "testing/mozbase/mozfile",
23 "testing/mozbase/mozprocess",
24 "testing/mozbase/moznetwork",
25 "third_party/python/jsmin",
26 "third_party/python/which",
28 "taskcluster/gecko_taskgraph/test",
31 sys
.path
[:0] = [os
.path
.join(topsrcdir
, p
) for p
in EXTRA_PATHS
]
33 sys
.path
.insert(0, OUR_DIR
)
38 "sphinx.ext.autosectionlabel",
40 "sphinx.ext.graphviz",
41 "sphinx.ext.napoleon",
45 "sphinxcontrib.mermaid",
47 "sphinx_markdown_tables",
52 # JSDoc must run successfully for dirs specified, so running
53 # tree-wide (the default) will not work currently.
54 # When adding more paths to this list, please ensure that they are not
55 # excluded from valid-jsdoc in the top-level .eslintrc.js.
57 "../browser/components/backup",
58 "../browser/components/extensions",
59 "../browser/components/migration",
60 "../browser/components/migration/content",
61 "../browser/components/uitour",
62 "../browser/components/urlbar",
63 "../remote/marionette",
64 "../testing/mochitest/BrowserTestUtils",
65 "../testing/mochitest/tests/SimpleTest/SimpleTest.js",
66 "../testing/mochitest/tests/SimpleTest/EventUtils.js",
67 "../testing/modules/Assert.sys.mjs",
68 "../testing/modules/TestUtils.sys.mjs",
70 "../toolkit/components/extensions",
71 "../toolkit/components/extensions/parent",
72 "../toolkit/components/featuregates",
73 "../toolkit/mozapps/extensions",
74 "../toolkit/components/prompts/src",
75 "../toolkit/components/pictureinpicture",
76 "../toolkit/components/pictureinpicture/content",
77 "../toolkit/components/search",
79 root_for_relative_js_paths
= ".."
80 jsdoc_config_path
= "jsdoc.json"
82 templates_path
= ["_templates"]
83 source_suffix
= [".rst", ".md"]
85 project
= "Firefox Source Docs"
87 # Override the search box to use Google instead of
88 # sphinx search on firefox-source-docs.mozilla.org
90 os
.environ
.get("MOZ_SOURCE_DOCS_USE_GOOGLE") == "1"
91 and os
.environ
.get("MOZ_SCM_LEVEL") == "3"
93 templates_path
.append("_search_template")
100 html_logo
= os
.path
.join(
101 topsrcdir
, "browser/branding/nightly/content/firefox-wordmark.svg"
103 html_favicon
= os
.path
.join(topsrcdir
, "browser/branding/nightly/firefox.ico")
105 exclude_patterns
= ["_build", "_staging", "_venv", "**security/nss/legacy/**"]
106 pygments_style
= "sphinx"
107 # generate label “slugs” for header anchors so that
108 # we can reference them from markdown links.
109 myst_heading_anchors
= 5
111 # We need to perform some adjustment of the settings and environment
112 # when running on Read The Docs.
113 on_rtd
= os
.environ
.get("READTHEDOCS", None) == "True"
116 # SHELL isn't set on RTD and mach.mixin.process's import raises if a
117 # shell-related environment variable can't be found. Set the variable here
118 # to hack us into working on RTD.
119 assert "SHELL" not in os
.environ
120 os
.environ
["SHELL"] = "/bin/bash"
122 # We only need to set the RTD theme when not on RTD because the RTD
123 # environment handles this otherwise.
124 import sphinx_rtd_theme
126 html_theme
= "sphinx_rtd_theme"
127 html_theme_path
= [sphinx_rtd_theme
.get_html_theme_path()]
130 html_static_path
= ["_static"]
131 htmlhelp_basename
= "FirefoxTreeDocs"
133 moz_project_name
= "main"
135 html_show_copyright
= False
137 # Only run autosection for the page title.
138 # Otherwise, we have a huge number of duplicate links.
139 # For example, the page https://firefox-source-docs.mozilla.org/code-quality/lint/
140 # is called "Linting"
141 # just like https://firefox-source-docs.mozilla.org/remote/CodeStyle.html
142 autosectionlabel_maxdepth
= 1
145 def install_sphinx_design(app
, pagename
, templatename
, context
, doctree
):
146 if "perfdocs" in pagename
:
147 app
.add_js_file("sphinx_design.js")
148 app
.add_css_file("sphinx_design.css")
152 app
.add_css_file("custom_theme.css")
153 app
.connect("html-page-context", install_sphinx_design
)