Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/features/feature_example/architecture/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[Feature Name] Architecture
===========================

.. document:: [Your Feature Name] Architecture
.. document:: [Feature Name] Architecture
:id: doc__feature_example_architecture
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/manuals/safety_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Safety Manual
=============
[Module Name] Safety Manual
===========================

.. note:: Document header

.. document:: [Your Module Name] Safety Manual
.. document:: [Module Name] Safety Manual
:id: doc__mod_temp_module_name_safety_manual
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/manuals/security_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Security Manual
===============
[Module Name] Security Manual
=============================

.. note:: Document header

.. document:: [Your Module Name] Security Manual
.. document:: [Module Name] Security Manual
:id: doc__mod_temp_module_name_security_manual
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/manuals/user_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@

.. _user_manual:

User Manual
###########
[Module Name] User Manual
=========================

.. document:: User Manual <module name>
.. document:: [Module Name] User Manual
:id: doc__user_manual
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/release/release_note.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Release Note
============
[Module Name] Release Note
==========================

.. note:: Document header

.. document:: [Your Module Name] Release Note
.. document:: [Module Name] Release Note
:id: doc__mod_temp_module_name_release_note
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/safety_mgt/module_safety_analysis_fdr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@
# *******************************************************************************


Safety Analysis Checklist
=========================
[Module Name] Safety Analysis Checklist
=======================================

.. document:: [Your Module Name] Safety Analysis Checklist
.. document:: [Module Name] Safety Analysis Checklist
:id: doc__mod_temp_module_name_safety_analysis_fdr
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/safety_mgt/module_safety_package_fdr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Safety Package Formal Review Report
===================================
[Module Name] Safety Package Formal Review Report
=================================================

.. note:: Document header

.. document:: [Your Module Name] Safety Package Formal Review
.. document:: [Module Name] Safety Package Formal Review
:id: doc__mod_temp_module_name_safety_package_fdr
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/safety_mgt/module_safety_plan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Safety Plan
***********
[Module Name] Safety Plan
=========================

.. note:: Document header

.. document:: [Your Module Name] Safety Plan
.. document:: [Module Name] Safety Plan
:id: doc__mod_temp_module_name_safety_plan
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/safety_mgt/module_safety_plan_fdr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Safety Plan Formal Review Report
================================
[Module Name] Safety Plan Formal Review Report
==============================================

.. note:: Document header

.. document:: [Your Module Name] Safety Plan Formal Review
.. document:: [Module Name] Safety Plan Formal Review
:id: doc__mod_temp_module_name_safety_plan_fdr
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/security_mgt/module_security_package_fdr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Security Package Formal Review Report
=====================================
[Module Name] Security Package Formal Review Report
===================================================

.. note:: Document header

.. document:: [Your Module Name] Security Package Formal Review
.. document:: [Module Name] Security Package Formal Review
:id: doc__mod_temp_module_name_sec_pkg_fdr
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/security_mgt/module_security_plan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Security Plan
=============
[Module Name] Security Plan
===========================

.. note:: Document header

.. document:: [Your Module Name] Security Plan
.. document:: [Module Name] Security Plan
:id: doc__mod_temp_module_name_security_plan
:status: draft
:version: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/module/security_mgt/module_security_plan_fdr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Security Plan Formal Review Report
==================================
[Module Name] Security Plan Formal Review Report
================================================

.. note:: Document header

.. document:: [Your Module Name] Security Plan Formal Review
.. document:: [Module Name] Security Plan Formal Review
:id: doc__mod_temp_module_name_security_plan_fdr
:status: draft
:version: 1
Expand Down
2 changes: 1 addition & 1 deletion docs/verification_report/module_verification_report.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Verification Report

.. note:: Document header

.. document:: [Your Module Name] Verification Report
.. document:: [Module Name] Verification Report
:id: doc__mod_temp_module_name_verification_report
:status: draft
:version: 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# *******************************************************************************


.. document:: [Your Component Name] Architecture Inspection Checklist
.. document:: [Component Name] Architecture Inspection Checklist
:id: doc__mod_temp_component_name_arc_inspection
:status: draft
:version: 1
Expand All @@ -25,13 +25,13 @@
.. attention::
The above directive must be updated according to your component.

- Modify ``Your Component Name`` to be your component Name
- Modify ``Component Name`` to be your component Name
- Modify ``id`` to be your component Name in lower snake case preceded by ``doc__`` and followed by ``_arc_inspection``
- Adjust ``status`` to be ``valid``
- Adjust ``safety``, ``security`` and ``tags`` according to your needs

Architecture Inspection Checklist
=================================
[Component Name] Architecture Inspection Checklist
==================================================

Purpose
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@

.. _component_architecture:

Component Architecture Documentation
====================================
[Component Name] Component Architecture Documentation
=====================================================

.. document:: [Your Component Name] Architecture
.. document:: [Component Name] Architecture
:id: doc__mod_temp_component_name_architecture
:status: draft
:version: 1
Expand All @@ -29,7 +29,7 @@ Component Architecture Documentation
.. attention::
The above directive must be updated according to your needs.

- Modify ``Your Component Name`` to be your Component Name
- Modify ``Component Name`` to be your Component Name
- Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_architecture``
- Adjust ``status`` to be ``valid``
- Adjust ``safety`` and ``tags`` according to your needs
Expand Down
4 changes: 2 additions & 2 deletions score/component_example/docs/architecture/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@

.. _component_architecture_template:

Component Architecture
======================
[Component Name] Component Architecture
=======================================

.. toctree::

Expand Down
8 changes: 4 additions & 4 deletions score/component_example/docs/component_classification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Component Classification
========================
[Component Name] Component Classification
=========================================

.. note:: Document header

.. document:: [Your Component Name] Component Classification
.. document:: [Component Name] Component Classification
:id: doc__mod_temp_component_name_comp_class
:status: draft
:version: 1
Expand All @@ -29,7 +29,7 @@ Component Classification
.. attention::
The above directive must be updated according to your Component.

- Modify ``Your Component Name`` to be your Component Name
- Modify ``Component Name`` to be your Component Name
- Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__``
- Adjust ``status`` to be ``valid``
- Adjust ``safety`` and ``tags`` according to your needs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. document:: [Your Component Name] Implementation Inspection Checklist
.. document:: [Component Name] Implementation Inspection Checklist
:id: doc__mod_temp_component_name_impl_inspection
:status: draft
:version: 1
Expand All @@ -24,13 +24,13 @@
.. attention::
The above directive must be updated according to your Component.

- Modify ``Your Component Name`` to be your Component Name
- Modify ``Component Name`` to be your Component Name
- Modify ``id`` to be your Component Name in lower snake case preceded by ``doc__`` and followed by ``_impl_inspection``
- Adjust ``status`` to be ``valid``
- Adjust ``safety``, ``security`` and ``tags`` according to your needs

Implementation Inspection Checklist
===================================
[Component Name] Implementation Inspection Checklist
====================================================

Purpose
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@

.. _detailed_design_example:

Example: Detailed Design
========================
[Component Name] Detailed Design
================================

.. document:: [Your Component Name] Detailed Design
.. document:: [Component Name] Detailed Design
:id: doc__mod_temp_component_name_detailed_design
:status: draft
:version: 1
Expand All @@ -29,13 +29,12 @@ Example: Detailed Design
.. attention::
The above directive must be updated according to your Component.

- Modify ``Your Component Name`` to be your Component Name
- Modify ``Component Name`` to be your Component Name
- Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_detailed_design``
- Adjust ``status`` to be ``valid``
- Adjust ``safety`` and ``tags`` according to your needs

Detailed Design for Component: <Component Name>
===============================================


Description
-----------
Expand Down
4 changes: 2 additions & 2 deletions score/component_example/docs/detailed_design/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@

.. _component_detailed_design_template:

Detailed Design
###############
[Component Name] Detailed Design
================================

.. attention::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# *******************************************************************************


.. document:: [Your Component Name] Requirements Inspection Checklist
.. document:: [Component Name] Requirements Inspection Checklist
:id: doc__mod_temp_component_name_req_inspection
:status: draft
:version: 2
Expand All @@ -25,13 +25,13 @@
.. attention::
The above directive must be updated according to your Component.

- Modify ``Your Component Name`` to be your Component Name
- Modify ``Component Name`` to be your Component Name
- Modify ``id`` to be your Component Name in lower snake case preceded by ``doc__`` and followed by ``_req_inspection``
- Adjust ``status`` to be ``valid``
- Adjust ``safety``, ``security`` and ``tags`` according to your needs

Requirement Inspection Checklist
================================
[Component Name] Requirement Inspection Checklist
=================================================

Purpose
-------
Expand Down
4 changes: 2 additions & 2 deletions score/component_example/docs/requirements/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Requirements
############
[Component Name] Requirements
=============================

.. toctree::

Expand Down
Loading
Loading