File: conf.py

package info (click to toggle)
python-autodocsumm 0.2.14-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 536 kB
  • sloc: python: 985; makefile: 171; sh: 21
file content (46 lines) | stat: -rw-r--r-- 1,146 bytes parent folder | download | duplicates (2)
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
import sys
import sphinx
sys.path.insert(0, '.')

master_doc = 'index'

extensions = ['autodocsumm']

if tuple(map(int, sphinx.__version__.split('.')[:2])) < (2, 1):
    autodoc_default_flags = ['show_inheritance', 'autosummary', 'members']
else:
    autodoc_default_options = {
        'show_inheritance': True,
        'autosummary': True,
        'members': True
        }

not_document_data = [
    'dummy.large_data', 'dummy.TestClass.small_data',
    'dummy_title.large_data', 'dummy_title.TestClass.small_data']

autodoc_typehints = "description"

autodata_content = 'both'

autodocsumm_section_sorter = True


def member_filter(app, what, name, obj, skip, options):
    import dummy
    import dummy_title
    if (obj is dummy.TestClass.class_caller or
            obj is dummy_title.TestClass.class_caller):
        return False
    return None


def group_member(app, what, name, obj, section, parent):
    if name == 'class_caller':
        return 'DummySection'


def setup(app):
    app.connect('autodoc-skip-member', member_filter)
    app.connect('autodocsumm-grouper', group_member)
    app.setup_extension('sphinx.ext.napoleon')