Demo Sphinx Needs external data

This is a demo from the Sphinx-Scale documentation project.

It demonstrates the usage of:

• need_import

Please see Sphinx-Scale documentation project for more details and source code.

Original Needs

Requirement: Dummy requirement REQ_1

layout: clean assignee: Alice links incoming: SPEC_1, TEST_1 connected by: SPEC_1

Specification: Dummy specification SPEC_1

layout: clean assignee: Bob links outgoing: REQ_1 links incoming: TEST_1 connects: REQ_1 connected by: TEST_1

Test Case: Dummy test case TEST_1

layout: clean assignee: Charlie links outgoing: SPEC_1, REQ_1 connects: SPEC_1

Created needs.json

Created via make needs.

{
    "created": "2021-04-17T22:32:14.277708",
    "current_version": "",
    "project": "Sphinx Needs external data",
    "versions": {
        "": {
            "created": "2021-04-17T22:32:14.277699",
            "filters": {},
            "filters_amount": 0,
            "needs": {
                "REQ_1": {
                    "assignee": "Alice",
                    "avatar": "",
                    "closed_at": "",
                    "completion": "",
                    "connects": [],
                    "connects_back": [
                        "SPEC_1"
                    ],
                    "created_at": "",
                    "description": "",
                    "docname": "index",
                    "duration": "",
                    "full_title": "Dummy requirement",
                    "hidden": "",
                    "id": "REQ_1",
                    "id_complete": "REQ_1",
                    "id_parent": "REQ_1",
                    "id_prefix": "",
                    "is_need": true,
                    "is_part": false,
                    "layout": "clean",
                    "links": [],
                    "max_amount": "",
                    "max_content_lines": "",
                    "parts": {},
                    "post_template": null,
                    "pre_template": null,
                    "query": "",
                    "section_name": "Original Needs",
                    "sections": [
                        "Original Needs",
                        "Demo Sphinx Needs external data"
                    ],
                    "service": "",
                    "signature": "",
                    "specific": "",
                    "status": null,
                    "style": null,
                    "tags": [],
                    "template": null,
                    "title": "Dummy requirement",
                    "type": "req",
                    "type_name": "Requirement",
                    "updated_at": "",
                    "url": "",
                    "user": ""
                },
                "SPEC_1": {
                    "assignee": "Bob",
                    "avatar": "",
                    "closed_at": "",
                    "completion": "",
                    "connects": [
                        "REQ_1"
                    ],
                    "connects_back": [
                        "TEST_1"
                    ],
                    "created_at": "",
                    "description": "",
                    "docname": "index",
                    "duration": "",
                    "full_title": "Dummy specification",
                    "hidden": "",
                    "id": "SPEC_1",
                    "id_complete": "SPEC_1",
                    "id_parent": "SPEC_1",
                    "id_prefix": "",
                    "is_need": true,
                    "is_part": false,
                    "layout": "clean",
                    "links": [
                        "REQ_1"
                    ],
                    "max_amount": "",
                    "max_content_lines": "",
                    "parts": {},
                    "post_template": null,
                    "pre_template": null,
                    "query": "",
                    "section_name": "Original Needs",
                    "sections": [
                        "Original Needs",
                        "Demo Sphinx Needs external data"
                    ],
                    "service": "",
                    "signature": "",
                    "specific": "",
                    "status": null,
                    "style": null,
                    "tags": [],
                    "template": null,
                    "title": "Dummy specification",
                    "type": "spec",
                    "type_name": "Specification",
                    "updated_at": "",
                    "url": "",
                    "user": ""
                },
                "TEST_1": {
                    "assignee": "Charlie",
                    "avatar": "",
                    "closed_at": "",
                    "completion": "",
                    "connects": [
                        "SPEC_1"
                    ],
                    "connects_back": [],
                    "created_at": "",
                    "description": "",
                    "docname": "index",
                    "duration": "",
                    "full_title": "Dummy test case",
                    "hidden": "",
                    "id": "TEST_1",
                    "id_complete": "TEST_1",
                    "id_parent": "TEST_1",
                    "id_prefix": "",
                    "is_need": true,
                    "is_part": false,
                    "layout": "clean",
                    "links": [
                        "SPEC_1",
                        "REQ_1"
                    ],
                    "max_amount": "",
                    "max_content_lines": "",
                    "parts": {},
                    "post_template": null,
                    "pre_template": null,
                    "query": "",
                    "section_name": "Original Needs",
                    "sections": [
                        "Original Needs",
                        "Demo Sphinx Needs external data"
                    ],
                    "service": "",
                    "signature": "",
                    "specific": "",
                    "status": null,
                    "style": null,
                    "tags": [],
                    "template": null,
                    "title": "Dummy test case",
                    "type": "test",
                    "type_name": "Test Case",
                    "updated_at": "",
                    "url": "",
                    "user": ""
                }
            },
            "needs_amount": 6
        }
    }
}

Imported needs

Using:

.. needimport:: needs.json

IMPORTED_REQ_1		Dummy requirement		Requirement
assignee: Alice			links incoming: IMPORTED_SPEC_1, IMPORTED_TEST_1 connected by: IMPORTED_SPEC_1
layout: complete				style: red_border

IMPORTED_SPEC_1		Dummy specification		Specification
assignee: Bob			links outgoing: IMPORTED_REQ_1 links incoming: IMPORTED_TEST_1 connects: IMPORTED_REQ_1 connected by: IMPORTED_TEST_1
layout: complete				style: red_border

IMPORTED_TEST_1		Dummy test case		Test Case
assignee: Charlie			links outgoing: IMPORTED_SPEC_1, IMPORTED_REQ_1 connects: IMPORTED_SPEC_1
layout: complete				style: red_border

All needs

ID	Title	Outgoing	Incoming	Connects	Connects Back
IMPORTED_REQ_1	Dummy requirement		IMPORTED_SPEC_1; IMPORTED_TEST_1		IMPORTED_SPEC_1
IMPORTED_SPEC_1	Dummy specification	IMPORTED_REQ_1	IMPORTED_TEST_1	IMPORTED_REQ_1	IMPORTED_TEST_1
IMPORTED_TEST_1	Dummy test case	IMPORTED_SPEC_1; IMPORTED_REQ_1		IMPORTED_SPEC_1
REQ_1	Dummy requirement		SPEC_1; TEST_1		SPEC_1
SPEC_1	Dummy specification	REQ_1	TEST_1	REQ_1	TEST_1
TEST_1	Dummy test case	SPEC_1; REQ_1		SPEC_1