File: conf.py

package info (click to toggle)
sphinx-needs 5.1.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 11,924 kB
  • sloc: python: 21,132; javascript: 187; makefile: 89; sh: 29; xml: 10
file content (77 lines) | stat: -rw-r--r-- 1,866 bytes parent folder | download
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
69
70
71
72
73
74
75
76
77
extensions = ["sphinx_needs"]

needs_types = [
    {
        "directive": "spec",
        "title": "Specification",
        "prefix": "SP_",
    }
]

needs_extra_links = [
    {
        "option": "link1",
        "incoming": "is linked by",
        "outgoing": "links to",
    },
    {
        "option": "link2",
        "incoming": "is linked by",
        "outgoing": "links to",
    },
    {
        "option": "link3",
        "incoming": "is linked by",
        "outgoing": "links to",
    },
]

needs_extra_options = [
    "option_1",
    "option_2",
    "option_3",
    "option_4",
    "option_5",
    "bad_value_type",
    "too_many_params",
]

needs_global_options = {
    "layout": {"default": "clean_l"},
    "option_1": {"default": "test_global"},
    "option_2": {"default": "[[copy('id')]]"},
    "option_3": {"predicates": [('status == "implemented"', "STATUS_IMPL")]},
    "option_4": {
        "default": "STATUS_UNKNOWN",
        "predicates": [('status == "closed"', "STATUS_CLOSED")],
    },
    "option_5": {
        "predicates": [
            ('status == "implemented"', "STATUS_IMPL"),
            ('status == "closed"', "STATUS_CLOSED"),
        ],
        "default": "final",
    },
    "link1": {"default": ["SPEC_1"]},
    "link2": {
        "predicates": [
            ('status == "implemented"', ["SPEC_2", "[[copy('link1')]]"]),
            ('status == "closed"', ["SPEC_3"]),
        ],
        "default": ["SPEC_1"],
    },
    "tags": {
        "predicates": [
            ('status == "implemented"', ["a", "b"]),
            ('status == "closed"', ["c"]),
        ],
        "default": ["d"],
    },
    "link3": {"default": 1},
    "bad_value_type": {"default": 1.27},
    "too_many_params": {"predicates": [("a", "b", "c", "d")]},
    "unknown": {"default": "unknown"},
}

needs_build_json = True
needs_json_remove_defaults = True