docs/conf.py

   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/.
   4
   5 import os
   6 import sys
   7
   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, ".."))
  11
  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
  15
  16 EXTRA_PATHS = (
  17     "layout/tools/reftest",
  18     "python/mach",
  19     "python/mozbuild",
  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",
  27     "docs/_addons",
  28     "taskcluster/gecko_taskgraph/test",
  29 )
  30
  31 sys.path[:0] = [os.path.join(topsrcdir, p) for p in EXTRA_PATHS]
  32
  33 sys.path.insert(0, OUR_DIR)
  34
  35 extensions = [
  36     "myst_parser",
  37     "sphinx.ext.autodoc",
  38     "sphinx.ext.autosectionlabel",
  39     "sphinx.ext.doctest",
  40     "sphinx.ext.graphviz",
  41     "sphinx.ext.napoleon",
  42     "sphinx.ext.todo",
  43     "mozbuild.sphinx",
  44     "sphinx_js",
  45     "sphinxcontrib.mermaid",
  46     "sphinx_copybutton",
  47     "sphinx_markdown_tables",
  48     "sphinx_design",
  49     "bzlink",
  50 ]
  51
  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.
  56 js_source_path = [
  57     "../browser/components/extensions",
  58     "../browser/components/migration",
  59     "../browser/components/migration/content",
  60     "../browser/components/uitour",
  61     "../browser/components/urlbar",
  62     "../remote/marionette",
  63     "../testing/mochitest/BrowserTestUtils",
  64     "../testing/mochitest/tests/SimpleTest/SimpleTest.js",
  65     "../testing/mochitest/tests/SimpleTest/EventUtils.js",
  66     "../testing/modules/Assert.sys.mjs",
  67     "../testing/modules/TestUtils.sys.mjs",
  68     "../toolkit/actors",
  69     "../toolkit/components/extensions",
  70     "../toolkit/components/extensions/parent",
  71     "../toolkit/components/featuregates",
  72     "../toolkit/mozapps/extensions",
  73     "../toolkit/components/prompts/src",
  74     "../toolkit/components/pictureinpicture",
  75     "../toolkit/components/pictureinpicture/content",
  76     "../toolkit/components/search",
  77 ]
  78 root_for_relative_js_paths = ".."
  79 jsdoc_config_path = "jsdoc.json"
  80
  81 templates_path = ["_templates"]
  82 source_suffix = [".rst", ".md"]
  83 master_doc = "index"
  84 project = "Firefox Source Docs"
  85
  86 # Override the search box to use Google instead of
  87 # sphinx search on firefox-source-docs.mozilla.org
  88 if (
  89     os.environ.get("MOZ_SOURCE_DOCS_USE_GOOGLE") == "1"
  90     and os.environ.get("MOZ_SCM_LEVEL") == "3"
  91 ):
  92     templates_path.append("_search_template")
  93
  94 html_sidebars = {
  95     "**": [
  96         "searchbox.html",
  97     ]
  98 }
  99 html_logo = os.path.join(
 100     topsrcdir, "browser/branding/nightly/content/firefox-wordmark.svg"
 101 )
 102 html_favicon = os.path.join(topsrcdir, "browser/branding/nightly/firefox.ico")
 103
 104 exclude_patterns = ["_build", "_staging", "_venv", "**security/nss/legacy/**"]
 105 pygments_style = "sphinx"
 106 # generate label “slugs” for header anchors so that
 107 # we can reference them from markdown links.
 108 myst_heading_anchors = 5
 109
 110 # We need to perform some adjustment of the settings and environment
 111 # when running on Read The Docs.
 112 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 113
 114 if on_rtd:
 115     # SHELL isn't set on RTD and mach.mixin.process's import raises if a
 116     # shell-related environment variable can't be found. Set the variable here
 117     # to hack us into working on RTD.
 118     assert "SHELL" not in os.environ
 119     os.environ["SHELL"] = "/bin/bash"
 120 else:
 121     # We only need to set the RTD theme when not on RTD because the RTD
 122     # environment handles this otherwise.
 123     import sphinx_rtd_theme
 124
 125     html_theme = "sphinx_rtd_theme"
 126     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 127
 128
 129 html_static_path = ["_static"]
 130 htmlhelp_basename = "FirefoxTreeDocs"
 131
 132 moz_project_name = "main"
 133
 134 html_show_copyright = False
 135
 136 # Only run autosection for the page title.
 137 # Otherwise, we have a huge number of duplicate links.
 138 # For example, the page https://firefox-source-docs.mozilla.org/code-quality/lint/
 139 # is called "Linting"
 140 # just like https://firefox-source-docs.mozilla.org/remote/CodeStyle.html
 141 autosectionlabel_maxdepth = 1
 142
 143
 144 def install_sphinx_design(app, pagename, templatename, context, doctree):
 145     if "perfdocs" in pagename:
 146         app.add_js_file("sphinx_design.js")
 147         app.add_css_file("sphinx_design.css")
 148
 149
 150 def setup(app):
 151     app.add_css_file("custom_theme.css")
 152     app.connect("html-page-context", install_sphinx_design)