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/.
5 from __future__
import absolute_import
, unicode_literals
10 from recommonmark
.transform
import AutoStructify
12 # Set up Python environment to load build system packages.
13 OUR_DIR
= os
.path
.dirname(__file__
)
14 topsrcdir
= os
.path
.normpath(os
.path
.join(OUR_DIR
, ".."))
16 # Escapes $, [, ] and 3 dots in copy button
17 copybutton_prompt_text
= r
">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
18 copybutton_prompt_is_regexp
= True
21 "layout/tools/reftest",
24 "python/mozversioncontrol",
25 "testing/mozbase/manifestparser",
26 "testing/mozbase/mozfile",
27 "testing/mozbase/mozprocess",
28 "third_party/python/jsmin",
29 "third_party/python/which",
32 sys
.path
[:0] = [os
.path
.join(topsrcdir
, p
) for p
in EXTRA_PATHS
]
34 sys
.path
.insert(0, OUR_DIR
)
38 "sphinx.ext.autosectionlabel",
40 "sphinx.ext.graphviz",
41 "sphinx.ext.napoleon",
45 "sphinxcontrib.mermaid",
48 "sphinx_markdown_tables",
52 # JSDoc must run successfully for dirs specified, so running
53 # tree-wide (the default) will not work currently.
55 "../browser/components/extensions",
56 "../browser/components/uitour",
57 "../remote/marionette",
58 "../toolkit/components/extensions",
59 "../toolkit/components/extensions/parent",
60 "../toolkit/components/featuregates",
61 "../toolkit/mozapps/extensions",
62 "../toolkit/components/prompts/src",
63 "../toolkit/components/pictureinpicture",
64 "../toolkit/components/pictureinpicture/content",
66 root_for_relative_js_paths
= ".."
67 jsdoc_config_path
= "jsdoc.json"
69 templates_path
= ["_templates"]
70 source_suffix
= [".rst", ".md"]
72 project
= "Firefox Source Docs"
73 html_logo
= os
.path
.join(
74 topsrcdir
, "browser/branding/nightly/content/firefox-wordmark.svg"
76 html_favicon
= os
.path
.join(topsrcdir
, "browser/branding/nightly/firefox.ico")
77 html_js_files
= ["https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.9.1/mermaid.js"]
79 exclude_patterns
= ["_build", "_staging", "_venv"]
80 pygments_style
= "sphinx"
82 # We need to perform some adjustment of the settings and environment
83 # when running on Read The Docs.
84 on_rtd
= os
.environ
.get("READTHEDOCS", None) == "True"
87 # SHELL isn't set on RTD and mach.mixin.process's import raises if a
88 # shell-related environment variable can't be found. Set the variable here
89 # to hack us into working on RTD.
90 assert "SHELL" not in os
.environ
91 os
.environ
["SHELL"] = "/bin/bash"
93 # We only need to set the RTD theme when not on RTD because the RTD
94 # environment handles this otherwise.
95 import sphinx_rtd_theme
97 html_theme
= "sphinx_rtd_theme"
98 html_theme_path
= [sphinx_rtd_theme
.get_html_theme_path()]
101 html_static_path
= ["_static"]
102 htmlhelp_basename
= "MozillaTreeDocs"
104 moz_project_name
= "main"
106 html_show_copyright
= False
108 # Only run autosection for the page title.
109 # Otherwise, we have a huge number of duplicate links.
110 # For example, the page https://firefox-source-docs.mozilla.org/code-quality/lint/
111 # is called "Linting"
112 # just like https://firefox-source-docs.mozilla.org/remote/CodeStyle.html
113 autosectionlabel_maxdepth
= 1
116 def install_sphinx_panels(app
, pagename
, templatename
, context
, doctree
):
117 if "raptor" in pagename
:
118 app
.add_js_file("sphinx_panels.js")
119 app
.add_css_file("sphinx_panels.css")
123 app
.add_config_value(
124 "recommonmark_config",
126 # Crashes with sphinx
127 "enable_inline_math": False,
128 # We use it for testing/web-platform/tests
129 "enable_eval_rst": True,
133 app
.add_css_file("custom_theme.css")
134 app
.add_transform(AutoStructify
)
135 app
.connect("html-page-context", install_sphinx_panels
)