gecko-dev/docs/conf.py

# 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 http://mozilla.org/MPL/2.0/.

from __future__ import absolute_import, unicode_literals

import os
import re
import sys

from datetime import datetime

from recommonmark.transform import AutoStructify

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

EXTRA_PATHS = (
    'layout/tools/reftest',
    'python/mach',
    'python/mozbuild',
    'python/mozversioncontrol',
    'testing/mozbase/manifestparser',
    'testing/mozbase/mozfile',
    'testing/mozbase/mozprocess',
    'third_party/python/futures',
    'third_party/python/jsmin',
    'third_party/python/which',
)

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

sys.path.insert(0, OUR_DIR)

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.autosectionlabel',
    'sphinx.ext.doctest',
    'sphinx.ext.graphviz',
    'sphinx.ext.napoleon',
    'sphinx.ext.todo',
    'mozbuild.sphinx',
    'sphinx_js',
    'sphinxcontrib.mermaid',
    'recommonmark',
]

# JSDoc must run successfully for dirs specified, so running
# tree-wide (the default) will not work currently.
js_source_path = [
    'browser/components/extensions',
    'browser/components/uitour',
    'testing/marionette',
    'toolkit/components/extensions',
    'toolkit/components/extensions/parent',
    'toolkit/components/featuregates',
    'toolkit/mozapps/extensions',
    'toolkit/components/prompts/src',
]
root_for_relative_js_paths = '.'
jsdoc_config_path = 'jsdoc.json'

templates_path = ['_templates']
source_suffix = '.rst'
source_suffix = ['.rst', '.md']
master_doc = 'index'
project = u'Firefox Source Tree Docs'
year = datetime.now().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('#'):
            continue

        release = line
        break

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'
else:
    # 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'

html_show_copyright = False


def setup(app):
    app.add_config_value('recommonmark_config', {
        # Crashes with sphinx
        'enable_inline_math': False,
        # We use it for testing/web-platform/tests
        'enable_eval_rst': True,
            }, True)
    app.add_stylesheet('custom_theme.css')
    app.add_transform(AutoStructify)