author Andrew Halberstadt <>
Wed, 22 Nov 2017 10:17:12 -0500
changeset 393095 7cc1270bf794f1e2354a93fd8d508f121f959bcf
parent 392802 026e085e839c97183e6cc528a8a3af183f7c118c
child 396610 c3ac950b0b8a71e4e5fbb478cdceb6a2777d66c0
permissions -rw-r--r--
Bug 1419772 - [docs] Enable the sphinx.ext.napoleon extension, r=gps This enables sphinx to parse both the google and numpy style docstring formats which tend to be more human readable than the default sphinx format. See: MozReview-Commit-ID: REmZ4IoUG8

# 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

from __future__ import unicode_literals

import os
import re
import sys

from recommonmark.parser import CommonMarkParser

from datetime import datetime

# Set up Python environment to load build system packages.
OUR_DIR = os.path.dirname(__file__)
topsrcdir = os.path.normpath(os.path.join(OUR_DIR, '..', '..'))


sys.path[:0] = [os.path.join(topsrcdir, p) for p in EXTRA_PATHS]

sys.path.insert(0, OUR_DIR)

extensions = [

# JSDoc must run successfully for dirs specified, so running
# tree-wide (the default) will not work currently.
js_source_path = ['toolkit/mozapps/extensions']
root_for_relative_js_paths = '.'
jsdoc_config_path = 'tools/docs/jsdoc.json'

templates_path = ['_templates']
source_suffix = '.rst'
source_suffix = ['.rst', '.md']
source_parsers = {
   '.md': CommonMarkParser,
master_doc = 'index'
project = u'Mozilla Source Tree Docs'
year =

# Grab the version from the source tree's milestone.
# FUTURE Use Python API from bug 941299.
with open(os.path.join(topsrcdir, 'config', 'milestone.txt'), 'rt') as fh:
    for line in fh:
        line = line.strip()

        if not line or line.startswith('#'):

        release = line

version = re.sub(r'[ab]\d+$', '', release)

exclude_patterns = ['_build', '_staging', '_venv']
pygments_style = 'sphinx'

# 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'
    # We only need to set the RTD theme when not on RTD because the RTD
    # environment handles this otherwise.
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

html_static_path = ['_static']
htmlhelp_basename = 'MozillaTreeDocs'

moz_project_name = 'main'