Skip to content
Snippets Groups Projects
conf.py 1.42 KiB
Newer Older
# -*- coding: utf-8 -*-

import sphinx.environment
from docutils.utils import get_source_line

MOCK_MODULES=[]

def _warn_node(self, msg, node, **kwargs):
    if not msg.startswith('nonlocal image URI found:'):
        self._warnfunc(msg, '%s:%s' % get_source_line(node), **kwargs)

sphinx.environment.BuildEnvironment.warn_node = _warn_node

def mock_modules():
    import sys

    from mock import MagicMock

    try:
        import numpy
    except ImportError:
        MOCK_MODULES.append('numpy')

    class Mock(MagicMock):
        @classmethod
        def __getattr__(cls, name):
            return Mock()

        def __call__(self, *args, **kwards):
            return Mock()

    sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
    print 'mocking {}'.format(MOCK_MODULES)

mock_modules()

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx.ext.autosummary',
    'sphinx.ext.napoleon',
]

templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
project = u'FORCE'
copyright = u'2017, FORCE Project'
version = '0.1.0'
release = '0.1.0.dev0'
pygments_style = 'sphinx'
html_theme = 'classic'
html_static_path = ['_static']
html_logo = '_static/force_logo.png'
htmlhelp_basename = 'FORCEdoc'
intersphinx_mapping = {'http://docs.python.org/': None}