diff --git a/docs/modules/communication/docs/safety_mgt/module_safety_plan.rst b/docs/modules/communication/docs/safety_mgt/module_safety_plan.rst index 8cb154818ad..c7f3f65b962 100644 --- a/docs/modules/communication/docs/safety_mgt/module_safety_plan.rst +++ b/docs/modules/communication/docs/safety_mgt/module_safety_plan.rst @@ -206,7 +206,7 @@ Module Documents Status For all the work product documents the status can be seen by following the "Link to WP". A summary of the status is also documented in the project's documentation management plan. -See :ref:`documents_docs_modules_communication_docs` +See :ref:`documents_docs_modules` Component Documents Status -------------------------- @@ -214,7 +214,7 @@ Component Documents Status For all the work product documents the status can be seen by following the "Link to WP". A summary of the status is also documented in the project's documentation management plan. -See :ref:`documents_docs_modules_communication_docs` +See :ref:`documents_docs_modules` Component Requirements Status ----------------------------- diff --git a/docs/modules/feo/docs/safety_mgt/module_safety_plan.rst b/docs/modules/feo/docs/safety_mgt/module_safety_plan.rst index 87d1e162167..ccbb6653331 100644 --- a/docs/modules/feo/docs/safety_mgt/module_safety_plan.rst +++ b/docs/modules/feo/docs/safety_mgt/module_safety_plan.rst @@ -252,7 +252,7 @@ Module Documents Status For all the work product documents the status can be seen by following the "Link to WP". A summary of the status is also documented in the project's documentation management plan. -See :ref:`documents_docs_modules_feo_docs` +See :ref:`documents_docs_modules` Component Documents Status -------------------------- @@ -260,7 +260,7 @@ Component Documents Status For all the work product documents the status can be seen by following the "Link to WP". A summary of the status is also documented in the project's documentation management plan. -See :ref:`documents_docs_modules_feo_docs` +See :ref:`documents_docs_modules` Component Requirements Status ----------------------------- diff --git a/docs/platform_management_plan/documentation_management.rst b/docs/platform_management_plan/documentation_management.rst index 88f1cb8077e..8b171fda6f5 100644 --- a/docs/platform_management_plan/documentation_management.rst +++ b/docs/platform_management_plan/documentation_management.rst @@ -15,7 +15,7 @@ .. document:: Documentation Management Plan :id: doc__documentation_mgt_plan :status: valid - :version: 2 + :version: 3 :safety: ASIL_B :security: YES :tags: platform_management @@ -115,188 +115,209 @@ docs/contribute .. _documents_docs_glossary: -docs/glossary -############# +.. _documents_docs_features: + +Feature documentation ++++++++++++++++++++++ + +In the following sections all documents of the features, that are +planned for release v1.0, are listed. + +.. _documents_docs_features_ai_platform: + +docs/features/ai_platform +######################### .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "glossary/" in need["docname"]: + if need["docname"] is not None and "features/ai_platform/" in need["docname"]: results.append(need) -.. _documents_docs_handbook: +.. _documents_docs_features_baselibs: -docs/handbook -############# +docs/features/baselibs +###################### .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "handbook/" in need["docname"]: + if need["docname"] is not None and "features/baselibs/" in need["docname"]: results.append(need) -.. _documents_docs_manuals: +.. _documents_docs_features_code_generation: -docs/manuals -############# +docs/features/code_generation +############################# .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "manuals/" in need["docname"]: + if need["docname"] is not None and "features/code_generation/" in need["docname"]: results.append(need) -.. _doc_platform_management_plan: +.. _documents_docs_features_communication: -docs/platform_management_plan -############################# +docs/features/communication +########################### .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "platform_management_plan/" in need["docname"]: + if need["docname"] is not None and "features/communication/" in need["docname"]: results.append(need) -.. _documents_docs_quality: +.. _documents_docs_features_configuration: -docs/quality -############ +docs/features/configuration +########################### .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "quality/" in need["docname"]: + if need["docname"] is not None and "features/configuration/" in need["docname"]: results.append(need) -.. _documents_docs_requirements: +.. _documents_docs_features_daal: -docs/requirements -################# +docs/features/daal +################## .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "requirements/" in need["docname"] and not "features/" in need["docname"] and not "modules/" in need["docname"]: + if need["docname"] is not None and "features/daal/" in need["docname"]: results.append(need) -.. _documents_docs_safety: +.. _documents_docs_features_diagnostics: -docs/safety -########### +docs/features/diagnostics +######################### .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "safety/" in need["docname"]: + if need["docname"] is not None and "features/diagnostics/" in need["docname"]: results.append(need) -.. _documents_docs_score_tools: +.. _documents_docs_features_feo: -docs/score_tools -################ +docs/features/feo +################# .. needtable:: :style: table - :columns: title;id;safety_affected;security_affected;status + :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] - for need in needs.filter_types(["doc_tool"]): - if need["docname"] is not None and "score_tools/" in need["docname"]: + for need in needs.filter_types(["document"]): + if need["docname"] is not None and "features/feo/" in need["docname"]: results.append(need) -.. _documents_docs_security: +.. _documents_docs_features_gen_ai: -docs/security -############# +docs/features/gen_ai +#################### .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "security/" in need["docname"]: + if need["docname"] is not None and "features/gen_ai/" in need["docname"]: results.append(need) -.. _documents_docs_tools: +.. _documents_docs_features_lifecycle: -docs/tools -########## +docs/features/lifecycle +####################### .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: docname + :sort: id results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "tools/" in need["docname"]: + if need["docname"] is not None and "features/lifecycle/" in need["docname"]: results.append(need) +.. _documents_docs_features_frameworks: + +.. _documents_docs_features_logging: -.. _documents_docs_features: +docs/features/logging +##################### -Feature documentation -+++++++++++++++++++++ +.. needtable:: + :style: table + :columns: title;id;safety;security;status + :colwidths: 25,45,10,10,10 + :sort: id -In the following sections all documents of the features and related modules (components), that are -planned for release v0.5, are listed. + results = [] -.. _documents_docs_features_baselibs: + for need in needs.filter_types(["document"]): + if need["docname"] is not None and "features/logging/" in need["docname"]: + results.append(need) -docs/features/baselibs -###################### + +.. _documents_docs_features_orchestration: + +docs/features/orchestration +########################### .. needtable:: :style: table @@ -307,13 +328,13 @@ docs/features/baselibs results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "features/baselibs/" in need["docname"]: + if need["docname"] is not None and "features/orchestration/" in need["docname"]: results.append(need) -.. _documents_docs_features_communication: +.. _documents_docs_features_os: -docs/features/communication -########################### +docs/features/os +################ .. needtable:: :style: table @@ -324,13 +345,14 @@ docs/features/communication results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "features/communication/" in need["docname"]: + if need["docname"] is not None and "features/os/" in need["docname"]: results.append(need) -.. _documents_docs_features_frameworks: -docs/features/frameworks -######################## +.. _documents_docs_features_persistency: + +docs/features/persistency +######################### .. needtable:: :style: table @@ -341,13 +363,13 @@ docs/features/frameworks results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "features/frameworks/" in need["docname"]: + if need["docname"] is not None and "features/persistency/" in need["docname"]: results.append(need) -.. _documents_docs_features_orchestration: +.. _documents_docs_features_security_crypto: -docs/features/orchestration -########################### +docs/features/security_crypto +############################# .. needtable:: :style: table @@ -358,13 +380,13 @@ docs/features/orchestration results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "features/orchestration/" in need["docname"]: + if need["docname"] is not None and "features/security_crypto/" in need["docname"]: results.append(need) -.. _documents_docs_features_persistency: +.. _documents_docs_features_time: -docs/features/persistency -######################### +docs/features/time +################## .. needtable:: :style: table @@ -375,100 +397,208 @@ docs/features/persistency results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "features/persistency/" in need["docname"]: + if need["docname"] is not None and "features/time/" in need["docname"]: results.append(need) +.. _documents_docs_features_tracing: -.. _documents_docs_modules: +docs/features/tracing +##################### -Modules documentation -+++++++++++++++++++++ +.. needtable:: + :style: table + :columns: title;id;safety;security;status + :colwidths: 25,45,10,10,10 + :sort: id -.. _documents_docs_modules_communication_docs: + results = [] -docs/modules/communication/docs -############################### + for need in needs.filter_types(["document"]): + if need["docname"] is not None and "features/tracing/" in need["docname"]: + results.append(need) + +docs/glossary +############# .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: id + :sort: docname results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "modules/communication/" in need["docname"]: + if need["docname"] is not None and "glossary/" in need["docname"]: results.append(need) -.. _documents_docs_modules_feo_docs: -docs/modules/feo/docs -##################### +.. _documents_docs_handbook: + +docs/handbook +############# .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: id + :sort: docname results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "modules/feo/" in need["docname"]: + if need["docname"] is not None and "handbook/" in need["docname"]: results.append(need) +.. _documents_docs_manuals: -.. _documents_docs_modules_logging_docs: +docs/manuals +############ -docs/modules/logging/docs -######################### +.. needtable:: + :style: table + :columns: title;id;safety;security;status + :colwidths: 25,45,10,10,10 + :sort: docname + + results = [] + + for need in needs.filter_types(["document"]): + if need["docname"] is not None and "manuals/" in need["docname"]: + results.append(need) + +.. _documents_docs_modules: + +docs/modules +############ .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: id + :sort: docname results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "modules/logging/" in need["docname"]: + if need["docname"] is not None and "modules/" in need["docname"]: results.append(need) -.. _documents_docs_modules_os_docs: +.. _doc_platform_management_plan: -docs/modules/os/docs -#################### +docs/platform_management_plan +############################# .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: id + :sort: docname results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "modules/os/" in need["docname"]: + if need["docname"] is not None and "platform_management_plan/" in need["docname"]: results.append(need) -.. _documents_docs_modules_tracing_docs: +.. _documents_docs_quality: -docs/modules/tracing/docs -######################### +docs/quality +############ .. needtable:: :style: table :columns: title;id;safety;security;status :colwidths: 25,45,10,10,10 - :sort: id + :sort: docname results = [] for need in needs.filter_types(["document"]): - if need["docname"] is not None and "modules/tracing/" in need["docname"]: + if need["docname"] is not None and "quality/" in need["docname"]: results.append(need) +.. _documents_docs_requirements: + +docs/requirements +################# + +.. needtable:: + :style: table + :columns: title;id;safety;security;status + :colwidths: 25,45,10,10,10 + :sort: docname + + results = [] + + for need in needs.filter_types(["document"]): + if need["docname"] is not None and "requirements/" in need["docname"] and not "features/" in need["docname"] and not "modules/" in need["docname"]: + results.append(need) -.. _documents_docs_modules_components: +.. _documents_docs_safety: + +docs/safety +########### + +.. needtable:: + :style: table + :columns: title;id;safety;security;status + :colwidths: 25,45,10,10,10 + :sort: docname + + results = [] + + for need in needs.filter_types(["document"]): + if need["docname"] is not None and "safety/" in need["docname"]: + results.append(need) + +.. _documents_docs_score_tools: + +docs/score_tools +################ + +.. needtable:: + :style: table + :columns: title;id;safety_affected;security_affected;status + :colwidths: 25,45,10,10,10 + :sort: docname + + results = [] + + for need in needs.filter_types(["doc_tool"]): + if need["docname"] is not None and "score_tools/" in need["docname"]: + results.append(need) + +.. _documents_docs_security: + +docs/security +############# + +.. needtable:: + :style: table + :columns: title;id;safety;security;status + :colwidths: 25,45,10,10,10 + :sort: docname + + results = [] + + for need in needs.filter_types(["document"]): + if need["docname"] is not None and "security/" in need["docname"]: + results.append(need) + +.. _documents_docs_tools: + +docs/tools +########## + +.. needtable:: + :style: table + :columns: title;id;safety;security;status + :colwidths: 25,45,10,10,10 + :sort: docname + + results = [] + + for need in needs.filter_types(["document"]): + if need["docname"] is not None and "tools/" in need["docname"]: + results.append(need)