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 from __future__ import absolute_import, unicode_literals
   6
   7 import os
   8 import sys
   9
  10 # Set up Python environment to load build system packages.
  11 OUR_DIR = os.path.dirname(__file__)
  12 topsrcdir = os.path.normpath(os.path.join(OUR_DIR, ".."))
  13
  14 # Escapes $, [, ] and 3 dots in copy button
  15 copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
  16 copybutton_prompt_is_regexp = True
  17
  18 EXTRA_PATHS = (
  19     "layout/tools/reftest",
  20     "python/mach",
  21     "python/mozbuild",
  22     "python/mozversioncontrol",
  23     "testing/mozbase/manifestparser",
  24     "testing/mozbase/mozfile",
  25     "testing/mozbase/mozprocess",
  26     "third_party/python/jsmin",
  27     "third_party/python/which",
  28     "docs/_addons",
  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_panels",
  49     "bzlink",
  50 ]
  51
  52 # JSDoc must run successfully for dirs specified, so running
  53 # tree-wide (the default) will not work currently.
  54 js_source_path = [
  55     "../browser/components/extensions",
  56     "../browser/components/uitour",
  57     "../browser/components/urlbar",
  58     "../remote/marionette",
  59     "../toolkit/actors",
  60     "../toolkit/components/extensions",
  61     "../toolkit/components/extensions/parent",
  62     "../toolkit/components/featuregates",
  63     "../toolkit/mozapps/extensions",
  64     "../toolkit/components/prompts/src",
  65     "../toolkit/components/pictureinpicture",
  66     "../toolkit/components/pictureinpicture/content",
  67 ]
  68 root_for_relative_js_paths = ".."
  69 jsdoc_config_path = "jsdoc.json"
  70
  71 templates_path = ["_templates"]
  72 source_suffix = [".rst", ".md"]
  73 master_doc = "index"
  74 project = "Firefox Source Docs"
  75 # Override the search box to use Google instead of
  76 # sphinx search
  77 html_sidebars = {
  78     "**": [
  79         "searchbox.html",
  80     ]
  81 }
  82 html_logo = os.path.join(
  83     topsrcdir, "browser/branding/nightly/content/firefox-wordmark.svg"
  84 )
  85 html_favicon = os.path.join(topsrcdir, "browser/branding/nightly/firefox.ico")
  86 html_js_files = ["https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.9.1/mermaid.js"]
  87
  88 exclude_patterns = ["_build", "_staging", "_venv"]
  89 pygments_style = "sphinx"
  90
  91 # We need to perform some adjustment of the settings and environment
  92 # when running on Read The Docs.
  93 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
  94
  95 if on_rtd:
  96     # SHELL isn't set on RTD and mach.mixin.process's import raises if a
  97     # shell-related environment variable can't be found. Set the variable here
  98     # to hack us into working on RTD.
  99     assert "SHELL" not in os.environ
 100     os.environ["SHELL"] = "/bin/bash"
 101 else:
 102     # We only need to set the RTD theme when not on RTD because the RTD
 103     # environment handles this otherwise.
 104     import sphinx_rtd_theme
 105
 106     html_theme = "sphinx_rtd_theme"
 107     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 108
 109
 110 html_static_path = ["_static"]
 111 htmlhelp_basename = "FirefoxTreeDocs"
 112
 113 moz_project_name = "main"
 114
 115 html_show_copyright = False
 116
 117 # Only run autosection for the page title.
 118 # Otherwise, we have a huge number of duplicate links.
 119 # For example, the page https://firefox-source-docs.mozilla.org/code-quality/lint/
 120 # is called "Linting"
 121 # just like https://firefox-source-docs.mozilla.org/remote/CodeStyle.html
 122 autosectionlabel_maxdepth = 1
 123
 124
 125 def install_sphinx_panels(app, pagename, templatename, context, doctree):
 126     if "perfdocs" in pagename:
 127         app.add_js_file("sphinx_panels.js")
 128         app.add_css_file("sphinx_panels.css")
 129
 130
 131 def setup(app):
 132     app.add_css_file("custom_theme.css")
 133     app.connect("html-page-context", install_sphinx_panels)