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
|
import os
version = "1.0"
extensions = ["sphinxcontrib.plantuml", "sphinx_needs"]
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"
needs_id_regex = "^[A-Za-z0-9_]"
needs_types = [
{
"directive": "req",
"title": "Requirement",
"prefix": "RE_",
"color": "#BFD8D2",
"style": "node",
},
{
"directive": "story",
"title": "User Story",
"prefix": "US_",
"color": "#BFD8D2",
"style": "node",
},
{
"directive": "spec",
"title": "Specification",
"prefix": "SP_",
"color": "#FEDCD2",
"style": "node",
},
{
"directive": "impl",
"title": "Implementation",
"prefix": "IM_",
"color": "#DF744A",
"style": "node",
},
{
"directive": "test",
"title": "Test Case",
"prefix": "TC_",
"color": "#DCB239",
"style": "node",
},
]
needs_extra_options = ["extra1", "extra2"]
test_dir = os.path.dirname(__file__)
test_json = os.path.join(test_dir, "needs_test_small.json")
# test_json = os.path.join(test_dir, 'needs_test_invalid.json')
# needs_external_needs = [{"base_url": f"file://{test_dir}", "json_url": f"file://{test_json}", "id_prefix": "ext_"}]
needs_external_needs = [
{
"base_url": "http://my_company.com/docs/v1/",
"json_path": "needs_test_small.json",
"id_prefix": "EXT_",
}
]
# Needed to export really ALL needs. The default entry would filter out all needs coming from external
needs_builder_filter = "True"
needs_json_remove_defaults = True
|