diff --git a/.gitignore b/.gitignore index 6c272ca..4b473df 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,13 @@ MODULE.bazel.lock # Ruff .ruff_cache + +# Python +.venv + +# Vale - editorial style guide +.vale.ini +styles/ + +# direnv - folder-specific bash configuration +.envrc diff --git a/docs/_assets/css/score.css b/docs/_assets/css/score.css index 031bffd..8c1d130 100644 --- a/docs/_assets/css/score.css +++ b/docs/_assets/css/score.css @@ -170,6 +170,7 @@ div.score_banner { #videowrapper{ position: relative; overflow: hidden; + margin-bottom: 50px; } #fullScreenDiv{ @@ -209,7 +210,7 @@ div.score_banner { /* font-size: 4.5em; */ font-size: 8.0cqw; font-weight: 900; - + margin-bottom: 20px; /* Is somehow cool with image/video title background */ /*animation: fadeIn 3s; */ } diff --git a/docs/_assets/css/score_design.css b/docs/_assets/css/score_design.css new file mode 100644 index 0000000..268ca78 --- /dev/null +++ b/docs/_assets/css/score_design.css @@ -0,0 +1,20 @@ +/* ########################### */ +/* SPHINX-DESIGN configs only! */ +/* ########################### */ + +.score-grid .sd-card-header { + background-color: var(--pst-color-secondary) !important; + color: var(--pst-color-text-muted); + font-weight: 900; + font-size: 1.2em; + +} +.score-grid .sd-card-body { + text-align: justify; +} + +details.sd-dropdown summary.sd-card-header + div.sd-summary-content +{ + background-color: transparent; + +} diff --git a/docs/_assets/css/score_needs.css b/docs/_assets/css/score_needs.css index 8ab71c0..ebc69be 100644 --- a/docs/_assets/css/score_needs.css +++ b/docs/_assets/css/score_needs.css @@ -70,3 +70,8 @@ html[data-theme="dark"] { background-color: var(--pst-color-table-row-zebra-high-bg); } +html[data-theme="dark"] { + --sn-color-need-bg-head: #20242b; + --sn-color-datatable-label: var(--pst-color-text-base) +} + diff --git a/docs/conf.py b/docs/conf.py index 4da3523..82e5bb7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,6 +31,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ + "sphinx_design", "sphinx_needs", ] @@ -49,18 +50,12 @@ html_css_files = [ "css/score.css", "css/score_needs.css", + "css/score_design.css", ] html_theme_options = { "navbar_align": "content", - "header_links_before_dropdown": 3, - "external_links": [ - {"name": "SCORE", "url": "https://eclipse-score.github.io"}, - { - "name": "Eclipse", - "url": "https://projects.eclipse.org/projects/automotive.score", - }, - ], + "header_links_before_dropdown": 5, "icon_links": [ { "name": "GitHub", diff --git a/docs/features/index.rst b/docs/features/index.rst index 16a5c80..c4b3282 100644 --- a/docs/features/index.rst +++ b/docs/features/index.rst @@ -12,7 +12,7 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _Platform_Features: +.. _features: Features ======== diff --git a/docs/features/infrastructure/index.rst b/docs/features/infrastructure/index.rst index bc30b1e..25aa77d 100644 --- a/docs/features/infrastructure/index.rst +++ b/docs/features/infrastructure/index.rst @@ -12,6 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* +.. _infrastructure_feratures: + ################ Infrastructure ################ diff --git a/docs/features/integration/index.rst b/docs/features/integration/index.rst index 6ec37f4..d5047a9 100644 --- a/docs/features/integration/index.rst +++ b/docs/features/integration/index.rst @@ -12,6 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* +.. _integration_features: + Integration ########### diff --git a/docs/index.rst b/docs/index.rst index 77a5edf..659486d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,7 @@ Documentation + .. raw:: html
@@ -35,12 +36,77 @@ Documentation
-.. toctree:: - :maxdepth: 2 - :glob: +Welcome & Overview +------------------ + +**Welcome to the Software documentation of the SCORE project.** + +If this is the first time you get in touch with SCORE, the `SCORE main page `__ +may be a good starting point to receive first insights of the project itself. + +Software artifacts +~~~~~~~~~~~~~~~~~~ + +.. grid:: 1 1 3 3 + :class-container: score-grid + + .. grid-item-card:: + + Requirements + ^^^ + Analyse :ref:`Stakeholder ` or :ref:`Tool ` requirements for + the work with and implementation inside SCORE. + Or get the complete picture on the :ref:`requirements` page. + + + + .. grid-item-card:: + + Features + ^^^ + :ref:`Features ` are the heart of the SCORE software. + Understand the internal details of :ref:`Infrastructure ` + or :ref:`Integration ` Features. + + .. grid-item-card:: + + Releases + ^^^ + Our release roadmap can be found under :ref:`releases`. + Including an overview about integrated software modules and their repository location. + + +Project structure and processes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. grid:: 1 1 2 2 + :class-container: score-grid + + .. grid-item-card:: + + Process + ^^^ + Understand how we work, by reading our :ref:`Process guide `. + And receive tips & tricks for our used tool stack by reading the pages :ref:`Templates ` and + :ref:`Tools `. + + .. grid-item-card:: + + Platform Management Plan (PMP) + ^^^ + Read about our project and organization structure in the + :ref:`Project Handbook `. + And learn how we deal with :ref:`safety_management` or care about :ref:`sw_verification`. + +.. dropdown:: Click to see the complete sitemap + + .. toctree:: + :maxdepth: 3 - requirements/index - features/index - process/index - platform_management_plan/index.rst - score_releases/index.rst + requirements/index + features/index + Releases + process/index + PMP + SCORE + Eclipse diff --git a/docs/platform_management_plan/index.rst b/docs/platform_management_plan/index.rst index 61e3674..157e800 100644 --- a/docs/platform_management_plan/index.rst +++ b/docs/platform_management_plan/index.rst @@ -12,6 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* +.. _pmp: + Platform Management Plan ======================== diff --git a/docs/platform_management_plan/project_management.rst b/docs/platform_management_plan/project_management.rst index 6296a7a..d79b21f 100644 --- a/docs/platform_management_plan/project_management.rst +++ b/docs/platform_management_plan/project_management.rst @@ -141,7 +141,7 @@ Platform consists of multiple repositories. The main repository, *SCORE*, is the integration repository, where everything comes together. It contains: * :ref:`stakeholder requirements ` -* documentation of all :ref:`platform features ` and features flags, +* documentation of all :ref:`platform features ` and features flags, feature requirements and architecture * build system including *SCORE* specific *macros* and *rules* * integration rules for software modules. diff --git a/docs/platform_management_plan/safety_management.rst b/docs/platform_management_plan/safety_management.rst index 24929a0..68db7df 100644 --- a/docs/platform_management_plan/safety_management.rst +++ b/docs/platform_management_plan/safety_management.rst @@ -12,6 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* +.. _safety_management: + Safety management ------------------------ diff --git a/docs/platform_management_plan/software_verification.rst b/docs/platform_management_plan/software_verification.rst index 0a878ae..81ad273 100644 --- a/docs/platform_management_plan/software_verification.rst +++ b/docs/platform_management_plan/software_verification.rst @@ -12,6 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* +.. _sw_verification: + Software Verification ------------------------ diff --git a/docs/process/guidelines/index.rst b/docs/process/guidelines/index.rst index 1ff3447..1ff7243 100644 --- a/docs/process/guidelines/index.rst +++ b/docs/process/guidelines/index.rst @@ -12,7 +12,7 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _Guidelines: +.. _configuration_tool_guidelines: ########### Guidelines @@ -25,4 +25,4 @@ git/index.rst branch/index.rst general/index.rst - contribution_request/index.rst \ No newline at end of file + contribution_request/index.rst diff --git a/docs/process/index.rst b/docs/process/index.rst index 42edc63..ebf1123 100644 --- a/docs/process/index.rst +++ b/docs/process/index.rst @@ -12,7 +12,7 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _Process_description: +.. _process_description: Process ======= diff --git a/docs/process/templates/index.rst b/docs/process/templates/index.rst index 7252cd5..43e5656 100644 --- a/docs/process/templates/index.rst +++ b/docs/process/templates/index.rst @@ -12,7 +12,7 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _Stakeholder_Requirements_Template: +.. _stakeholder_requirements_template: Stakeholder Requirements Template ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/requirements.txt b/docs/requirements.txt index 3e5cf07..65c52d0 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ Sphinx==8.1.3 sphinx-needs==4.1.0 pydata-sphinx-theme==0.16.0 +sphinx-design==0.6.1 diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst index fe06ad6..c5b4b01 100644 --- a/docs/requirements/index.rst +++ b/docs/requirements/index.rst @@ -12,6 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* +.. _requirements: + Requirements ============ diff --git a/docs/requirements/stakeholder/index.rst b/docs/requirements/stakeholder/index.rst index 91f7335..33c27e5 100644 --- a/docs/requirements/stakeholder/index.rst +++ b/docs/requirements/stakeholder/index.rst @@ -12,7 +12,7 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _Stakeholder_Requirements: +.. _stakeholder_requirements: Stakeholder Requirements ======================== diff --git a/docs/requirements/tool/index.rst b/docs/requirements/tool/index.rst index 6cc8a70..2dc5be5 100644 --- a/docs/requirements/tool/index.rst +++ b/docs/requirements/tool/index.rst @@ -12,7 +12,7 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _Tool_Requirements: +.. _tool_requirements: Tool Requirements ================= diff --git a/docs/requirements_lock.txt b/docs/requirements_lock.txt index 8493462..b5a7228 100644 --- a/docs/requirements_lock.txt +++ b/docs/requirements_lock.txt @@ -355,12 +355,17 @@ sphinx==8.1.3 \ # -r docs/requirements.txt # pydata-sphinx-theme # sphinx-data-viewer + # sphinx-design # sphinx-needs # sphinxcontrib-jquery sphinx-data-viewer==0.1.5 \ --hash=sha256:a7d5e58613562bb745380bfe61ca8b69997998167fd6fa9aea55606c9a4b17e4 \ --hash=sha256:b74b1d304c505c464d07c7b225ed0d84ea02dcc88bc1c49cdad7c2275fbbdad4 # via sphinx-needs +sphinx-design==0.6.1 \ + --hash=sha256:b11f37db1a802a183d61b159d9a202314d4d2fe29c163437001324fe2f19549c \ + --hash=sha256:b44eea3719386d04d765c1a8257caca2b3e6f8421d7b3a5e742c0fd45f84e632 + # via -r docs/requirements.txt sphinx-needs==4.1.0 \ --hash=sha256:7d40e9c29353d9784f469b2093412846060cda4f3b55127ac58a2692c3381ef9 \ --hash=sha256:8ae21e10515249aaba3dabd7fd66afdedd1160ecbc5816337fb6ed82aca293b7 diff --git a/docs/score_releases/index.rst b/docs/score_releases/index.rst index 6538735..0e1ea52 100644 --- a/docs/score_releases/index.rst +++ b/docs/score_releases/index.rst @@ -12,6 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* +.. _releases: + SCORE Releases Overview =======================