explorepy/docs/conf.py at b485ff36b87ace73f53550375f4219e4100ccc5e · Mentalab-hub/explorepy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
import os
import sys

sys.path.insert(0, os.path.abspath('../src/explorepy/'))
autodoc_mock_imports = ['bluetooth', 'pylsl', 'bokeh', 'tornado']

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.coverage',
    'sphinx.ext.doctest',
    'sphinx.ext.extlinks',
    'sphinx.ext.ifconfig',
    'sphinx.ext.napoleon',
    'sphinx.ext.todo',
    'sphinx.ext.viewcode',
]
if os.getenv('SPELLCHECK'):
    extensions += 'sphinxcontrib.spelling',
    spelling_show_suggestions = True
    spelling_lang = 'en_US'

source_suffix = '.rst'
master_doc = 'index'
project = 'explorepy'
year = '2018-2025'
author = 'Mentalab GmbH.'
copyright = '{0}, {1}'.format(year, author)
version = release = '4.5.0'
pygments_style = 'trac'
templates_path = ['.']
extlinks = {
    'issue': ('https://github.com/Mentalab-hub/explorepy/issues/%s', '#'),
    'pr': ('https://github.com/Mentalab-hub/explorepy/pull/%s', 'PR #'),
}

html_theme = 'sphinx_rtd_theme'

html_use_smartypants = True
html_last_updated_fmt = '%b %d, %Y'
html_split_index = False
html_sidebars = {
   '**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html'],
}
html_short_title = '%s-%s' % (project, version)

# If false, no module index is generated.
html_domain_indices = True

napoleon_google_docstring = True

napoleon_use_ivar = True
napoleon_use_rtype = False
napoleon_use_param = False
napoleon_include_private_with_doc = True
napoleon_include_special_with_doc = True

autoclass_content = 'both'
autodoc_default_flags = [
    'members',
    'inherited-members',
    'private-members',
    'show-inheritance',
]
autodoc_member_order = 'bysource'
autosummary_generate = True