update documentation

ThalesGroup · Dec 30, 2023 · e59dde1 · e59dde1
1 parent c3988f6
commit e59dde1
Show file tree

Hide file tree

Showing 14 changed files with 409 additions and 77 deletions.
diff --git a/README.md b/README.md
@@ -21,31 +21,8 @@ It provides all SMP components to develop and test catalogues:
 
 - a Component Development Kit (CDK)
 - a lightweight simulator and standard services for test purpose
-- a Python binding to ease the writing of unit-tests
+- a Python SMP unit-tests framework
 
-## System Requirements
-
-- Linux, Windows or MacOS
-- A C++ 17 compiler: Clang 5+, GCC 7+ and MSVC 2019+ are officially supported
-- CMake 3.14+
-- Python 3.7+ and pytest
-
-## How to Build
-
-Both CMake and Python (pip) builds are supported.
-
-### Build with CMake
-
-```bash
-cmake -B ./build -DCMAKE_BUILD_TYPE=Release
-cmake --build ./build --config Release
-```
-
-### Build with Python (pip)
-
-```bash
-python -m pip install .[test] -v
-```
 
 ## Documentation
 

diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/REQUIREMENTS.md b/docs/REQUIREMENTS.md
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,3 +1 @@
-theme: jekyll-theme-minimal
-title: XSMP-SDK's homepage
-description: Homepage for the Xsmp Simulator Development Kit
+title: XSMP-SDK
diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml
@@ -0,0 +1,11 @@
+nav:
+- section: "Get Started"
+  items:
+  - title: "System Requirements"
+    url: "/requirements.html"
+  - title: "Quickstart"
+    url: "/quickstart.html"
+  - title: "FAQ"
+    url: "/faq.html"
+
+
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: " en-US" }}">
+
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    {% seo %}
+    <link rel="stylesheet" href="{{ " /assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
+</head>
+
+<body>
+    <div class="sidebar">
+        <div class="header">
+            <h1>
+                <a href="{{ " /" | relative_url }}">{{ site.title | default:
+                    "Documentation" }}</a>
+            </h1>
+        </div>
+        <input type="checkbox" id="nav-toggle" class="nav-toggle"> <label for="nav-toggle" class="expander"> <span
+                class="arrow"></span>
+        </label>
+        <nav>
+            {% for item in site.data.navigation.nav %}
+            <h2>{{ item.section }}</h2>
+            <ul>
+                {% for subitem in item.items %}
+                <a href="{{subitem.url | relative_url }}">
+                    <li class="{% if subitem.url == page.url %}active{% endif %}">
+                        {{ subitem.title }}</li>
+                </a> {% endfor %}
+            </ul>
+            {% endfor %}
+        </nav>
+    </div>
+    <div class="main markdown-body">
+        <div class="main-inner">{{ content }}</div>
+        <div class="footer">
+            XSMP-SDK &middot; <a href="https://github.com/ThalesGroup/xsmp-sdk">GitHub
+                Repository</a> &middot; <a href="https://github.com/ThalesGroup/xsmp-sdk/blob/main/LICENSE">License</a>
+        </div>
+    </div>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/5.0.0/anchor.min.js"></script>
+    <script>
+        anchors.add('.main h2, .main h3, .main h4, .main h5, .main h6');
+    </script>
+</body>
+
+</html>
diff --git a/docs/_sass/main.scss b/docs/_sass/main.scss
@@ -0,0 +1,196 @@
+$sidebar-width: 260px;
+
+body {
+    display: flex;
+    margin: 0;
+}
+
+.sidebar {
+    background: $black;
+    color: $text-white;
+    flex-shrink: 0;
+    height: 100vh;
+    overflow: auto;
+    position: sticky;
+    top: 0;
+    width: $sidebar-width;
+}
+
+.sidebar h1 {
+    font-size: 1.5em;
+}
+
+.sidebar h2 {
+    color: $gray-light;
+    font-size: 0.8em;
+    font-weight: normal;
+    margin-bottom: 0.8em;
+    padding-left: 2.5em;
+    text-transform: uppercase;
+}
+
+.sidebar .header {
+    background: $black;
+    padding: 2em;
+    position: sticky;
+    top: 0;
+    width: 100%;
+}
+
+.sidebar .header a {
+    color: $text-white;
+    text-decoration: none;
+}
+
+.sidebar .nav-toggle {
+    display: none;
+}
+
+.sidebar .expander {
+    cursor: pointer;
+    display: none;
+    height: 3em;
+    position: absolute;
+    right: 1em;
+    top: 1.5em;
+    width: 3em;
+}
+
+.sidebar .expander .arrow {
+    border: solid $white;
+    border-width: 0 3px 3px 0;
+    display: block;
+    height: 0.7em;
+    margin: 1em auto;
+    transform: rotate(45deg);
+    transition: transform 0.5s;
+    width: 0.7em;
+}
+
+.sidebar nav {
+    width: 100%;
+}
+
+.sidebar nav ul {
+    list-style-type: none;
+    margin-bottom: 1em;
+    padding: 0;
+
+    &:last-child {
+        margin-bottom: 2em;
+    }
+
+    a {
+        text-decoration: none;
+    }
+
+    li {
+        color: $text-white;
+        padding-left: 2em;
+        text-decoration: none;
+    }
+
+    li.active {
+        background: $border-gray-darker;
+        font-weight: bold;
+    }
+
+    li:hover {
+        background: $border-gray-darker;
+    }
+}
+
+.main {
+    background-color: $bg-gray;
+    width: calc(100% - #{$sidebar-width});
+}
+
+.main .main-inner {
+    background-color: $white;
+    padding: 2em;
+}
+
+.main .footer {
+    margin: 0;
+    padding: 2em;
+}
+
+.main table th {
+    text-align: left;
+}
+
+.main .callout {
+    border-left: 0.25em solid $white;
+    padding: 1em;
+
+    a {
+        text-decoration: underline;
+    }
+
+    &.important {
+        background-color: $bg-yellow-light;
+        border-color: $bg-yellow;
+        color: $black;
+    }
+
+    &.note {
+        background-color: $bg-blue-light;
+        border-color: $text-blue;
+        color: $text-blue;
+    }
+
+    &.tip {
+        background-color: $green-000;
+        border-color: $green-700;
+        color: $green-700;
+    }
+
+    &.warning {
+        background-color: $red-000;
+        border-color: $text-red;
+        color: $text-red;
+    }
+}
+
+.main .good pre {
+    background-color: $bg-green-light;
+}
+
+.main .bad pre {
+    background-color: $red-000;
+}
+
+@media all and (max-width: 768px) {
+    body {
+        flex-direction: column;
+    }
+
+    .sidebar {
+        height: auto;
+        position: relative;
+        width: 100%;
+    }
+
+    .sidebar .expander {
+        display: block;
+    }
+
+    .sidebar nav {
+        height: 0;
+        overflow: hidden;
+    }
+
+    .sidebar .nav-toggle:checked {
+        &~nav {
+            height: auto;
+        }
+
+        &+.expander .arrow {
+            transform: rotate(-135deg);
+        }
+    }
+
+    .main {
+        width: 100%;
+    }
+}
diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
@@ -0,0 +1,4 @@
+--- --- 
+
+@import "jekyll-theme-primer";
+@import "main";
diff --git a/docs/faq.md b/docs/faq.md
@@ -0,0 +1,2 @@
+# XSMP-SDK FAQ
+
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,19 @@
+# XSMP Simulator Development Kit User's Guide
+
+## Welcome to XSMP-SDK!
+
+
+XSMP Simulator Development Kit is a framework for development of SMDL (Simulation Model Definition Language) as defined in the [ECSS SMP standard](https://ecss.nl/standard/ecss-e-st-40-07c-simulation-modelling-platform-2-march-2020/).
+
+It provides all SMP components to develop and test catalogues:
+
+- a Component Development Kit (CDK)
+- a lightweight simulator and standard services for test purpose
+- a Python SMP unit-tests framework
+
+
+The XSMP-SDK is developed in conjunction with [XSMP-Modeler](https://github.com/ThalesGroup/xsmp-modeler-core).
+
+
+
+