Docs: source code for RZG HMI SDK (v1.00) website

Signed-off-by: Djuned Fernando DJUSDEK <[email protected]>
Signed-off-by: Yoshihito Ogawa <[email protected]>

.github/workflows/docs-update.yml

@@ -0,0 +1,47 @@
+name: Publish Documentation
+
+on:
+  push:
+    # Pattern matched against refs/tags
+    tags:
+      - '**'           # Push events to every tag including hierarchical tags like v1.0/beta
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Setup Environments
+        run: |
+          cd docs
+          . work/setup.sh
+
+      - name: Compile Documentations
+        run: |
+          cd docs
+          mike deploy --push --update-aliases ${GITHUB_REF_NAME} latest
+          mike set-default --push latest

README.md

@@ -0,0 +1,4 @@
+# HMI SDK on RZ/G series
+
+The best solution for starting your HMI applications.
+

docs/.gitignore

@@ -0,0 +1 @@
+site/

docs/README.md

@@ -0,0 +1,57 @@
+# rzg_hmi_sdk/docs
+
+This is a documentation sources for [rzg_hmi_sdk](https://renesas-rz.github.io/rzg_hmi_sdk) website (github.io).
+
+## Prepare environment
+
+Python3 and pip3 are required.
+
+In some case you may need to make a `symlink` to pip (of python3).
+
+### Setup from script
+
+Working directory should be `rzg_hmi_sdk/docs/`.
+
+```
+. work/setup.sh
+```
+
+### Serve local server
+
+Working directory should be `rzg_hmi_sdk/docs/`.
+
+```
+. serve.sh
+```
+
+## Test versioning with `mike`
+
+Working directory should be `rzg_hmi_sdk/docs/`.
+
+### Deploy
+
+This will generate a static website into `local/gh-pages` branch.
+
+`dev` will be used as version.
+
+```
+. mike/deploy.sh
+```
+
+### Serve
+
+You must deploy first.
+
+```
+. mike/serve.sh
+```
+
+### Clean-up
+
+This step is not mandatory.
+
+After you complete checking your website, you may want to remove `local/gh-pages` branch.
+
+```
+. mike/remove.sh
+```

docs/docs/_themes/announce.html

@@ -0,0 +1,16 @@
+{% if config.extra.announcements %}
+  <p>
+    {% for announce in config.extra.announcements %}
+      {% if config.extra.announcements_urls %}
+        {% for urls in config.extra.announcements_urls %}
+          {% for key, value in urls.items() %}
+            {{ announce | replace(key, "<a href=" + nav.homepage.url | url + "/" + value + ">" + key + "</a>") }}
+          {% endfor %}
+        {% endfor %}
+      {% else %}
+        {{ announce }}
+      {% endif %}
+      <br/>
+    {% endfor %}
+  </p>
+{% endif %}

docs/docs/_themes/g_translate.html

@@ -0,0 +1,24 @@
+{#-
+  This code was originally taken from
+    https://stackoverflow.com/a/32020855
+  by
+    Mousey
+  and may be subject to copyright.
+-#}
+
+<div id="google_translate_element"></div>
+<script type="text/javascript">
+  var userLang = navigator.language || navigator.userLanguage || navigator.languages;
+  if (userLang.substr(0,2) != "en"){
+    function googleTranslateElementInit() {
+      new google.translate.TranslateElement({
+        pageLanguage: 'en',
+        layout: google.translate.TranslateElement.FloatPosition.TOP_LEFT
+      }, 'google_translate_element');
+    }
+  }
+  else {
+    document.getElementById("google_translate_element").style.display="none";
+  }
+</script>
+<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>

docs/docs/_themes/main.html

@@ -0,0 +1,12 @@
+{% extends "base.html" %}
+<!-- start extrahead block -->
+{% block extrahead %}
+  {% include 'g_translate.html' ignore missing %}
+  {{ super() }}
+{% endblock %}
+<!-- end extrahead block -->
+<!-- start announce block -->
+{% block announce %}
+  {% include 'announce.html' ignore missing %}
+{% endblock %}
+<!-- end announce block -->

docs/docs/_themes/partials/header.html

@@ -0,0 +1,101 @@
+{#-
+  Copyright (c) 2016-2024 Martin Donath <martin[email protected]>
+  Copyright (c) 2024 Renesas Electronics Corporation and/or its affiliates
+  SPDX-License-Identifier: MIT
+
+  This code was originally taken from
+    https://github.com/squidfunk/mkdocs-material/blob/master/material/templates/partials/header.html
+  and have sources in
+    https://github.com/squidfunk/mkdocs-material/blob/master/src/templates/partials/header.html
+-#}
+
+{% set class = "md-header" %}
+{% if "navigation.tabs.sticky" in features %}
+  {% set class = class ~ " md-header--shadow md-header--lifted" %}
+{% elif "navigation.tabs" not in features %}
+  {% set class = class ~ " md-header--shadow" %}
+{% endif %}
+<header class="{{ class }}" data-md-component="header">
+  <nav class="md-header__inner md-grid" aria-label="{{ lang.t('header') }}">
+    {% if config.theme.logo %}
+      {% if config.extra.homepage is defined %}
+        {% set target = "_blank" %}
+        {% set title = "Home" %}
+        {% set component = "" %}
+      {% else %}
+        {% set target = "_self" %}
+        {% set title = config.site_name | e %}
+        {% set component = "logo" %}
+      {% endif %}
+      <a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ title }}" class="md-header__button md-logo" aria-label="{{ config.site_name }}" data-md-component="{{ component }}" target="{{ target }}">
+        {% include "partials/logo.html" %}
+      </a>
+    {% endif %}
+    <label class="md-header__button md-icon" for="__drawer">
+      {% set icon = config.theme.icon.menu or "material/menu" %}
+      {% include ".icons/" ~ icon ~ ".svg" %}
+    </label>
+    {% if config.theme.logo and config.extra.header_link is defined %}
+      {% set class = "md-ellipsis header-link" %}
+      {% set component = "" %}
+    {% elif config.extra.header_link is defined %}
+      {% set class = "md-ellipsis header-link header-link-no-icon" %}
+      {% set component = "" %}
+    {% else %}
+      {% set class = "md-ellipsis" %}
+      {% set component = "header-title" %}
+    {% endif %}
+    <div class="md-header__title" data-md-component="{{ component }}">
+      <div class="md-header__ellipsis">
+        <div class="md-header__topic">
+          <span class="{{ class }}">
+            {% if config.extra.header_link is defined %}
+              <a href="{{ nav.homepage.url | url }}" title="{{ config.site_name | e }}" data-md-component="logo">
+                {{ config.site_name }}
+              </a>
+            {% else %}
+              {{ config.site_name }}
+            {% endif %}
+          </span>
+        </div>
+        <div class="md-header__topic" data-md-component="header-topic">
+          <span class="md-ellipsis">
+            {% if page.meta and page.meta.title %}
+              {{ page.meta.title }}
+            {% else %}
+              {{ page.title }}
+            {% endif %}
+          </span>
+        </div>
+      </div>
+    </div>
+    {% if config.theme.palette %}
+      {% if not config.theme.palette is mapping %}
+        {% include "partials/palette.html" %}
+      {% endif %}
+    {% endif %}
+    {% if not config.theme.palette is mapping %}
+      {% include "partials/javascripts/palette.html" %}
+    {% endif %}
+    {% if config.extra.alternate %}
+      {% include "partials/alternate.html" %}
+    {% endif %}
+    {% if "material/search" in config.plugins %}
+      <label class="md-header__button md-icon" for="__search">
+        {% set icon = config.theme.icon.search or "material/magnify" %}
+        {% include ".icons/" ~ icon ~ ".svg" %}
+      </label>
+      {% include "partials/search.html" %}
+    {% endif %}
+    {% if config.repo_url %}
+      <div class="md-header__source">
+        {% include "partials/source.html" %}
+      </div>
+    {% endif %}
+  </nav>
+  {% if "navigation.tabs.sticky" in features %}
+    {% if "navigation.tabs" in features %}
+      {% include "partials/tabs.html" %}
+    {% endif %}
+  {% endif %}
+</header>

docs/docs/_themes/partials/nav-top-btn.html

@@ -0,0 +1,9 @@
+{% if config.theme.nav_top and config.theme.nav_top.btn %}
+  <li class="md-nav__item" id="md-nav-top-btn">
+    <a href="{{ config.theme.nav_top.btn.url | url }}" class="md-nav__link md-button md-button--primary btn-yellow">
+      <span class="md-ellipsis">
+        {{ config.theme.nav_top.btn.name }}
+      </span>
+    </a>
+  </li>
+{% endif %}

docs/docs/_themes/partials/nav-top.html

@@ -0,0 +1,33 @@
+{% if config.theme.logo %}
+  {% set class = "md-nav-top-title" %}
+{% else %}
+  {% set class = "md-nav-top-title md-nav-top-no-icon" %}
+{% endif %}
+<div class="{{ class }}">
+  <a id="md-nav-top-home" href="{{ nav.homepage.url | url }}">
+    {{ config.site_name }}
+  </a>
+  <span>
+    {{ config.site_name }}
+  </span>
+  {% if config.site_description %}
+    <p class="md-nav-top-subtitle">
+      {{ config.site_description }}
+    </p>
+  {% endif %}
+  <div class="md-nav-top-logos md-typeset">
+    {% if config.theme.nav_top %}
+      {% for logo in config.theme.nav_top.logos %}
+        <img src="{{ logo | url }}">
+      {% endfor %}
+    {% endif %}
+    {% if config.theme.nav_top and config.theme.nav_top.btn %}
+      <p>
+        <a class="md-button md-button--primary btn-yellow btn-round btn-small" href="{{ config.theme.nav_top.btn.url | url }}" >
+          {{ config.theme.nav_top.btn.name }}
+        </a>
+      </p>
+    {% endif %}
+    <hr/>
+  </div>
+</div>

docs/docs/_themes/partials/nav.html

@@ -0,0 +1,48 @@
+{#-
+  Copyright (c) 2016-2024 Martin Donath <martin[email protected]>
+  Copyright (c) 2024 Renesas Electronics Corporation and/or its affiliates
+  SPDX-License-Identifier: MIT
+
+  This code was originally taken from
+    https://github.com/squidfunk/mkdocs-material/blob/master/material/templates/partials/nav.html
+  and have sources in
+    https://github.com/squidfunk/mkdocs-material/blob/master/src/templates/partials/nav.html
+-#}
+
+{% import "partials/nav-item.html" as item with context %}
+{% set class = "md-nav md-nav--primary" %}
+{% if "navigation.tabs" in features %}
+  {% set class = class ~ " md-nav--lifted" %}
+{% endif %}
+{% if "toc.integrate" in features %}
+  {% set class = class ~ " md-nav--integrated" %}
+{% endif %}
+<nav class="{{ class }}" aria-label="{{ lang.t('nav') }}" data-md-level="0">
+  <label class="md-nav__title" for="__drawer">
+    {% if config.theme.logo %}
+      {% if config.extra.homepage is defined %}
+        {% set target = "_blank" %}
+        {% set title = "Home" %}
+      {% else %}
+        {% set target = "_self" %}
+        {% set title = config.site_name | e %}
+      {% endif %}
+      <a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ title }}" class="md-nav__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo" target="{{ target }}">
+        {% include "partials/logo.html" %}
+      </a>
+    {% endif %}
+    {% include "partials/nav-top.html" %}
+  </label>
+  {% if config.repo_url %}
+    <div class="md-nav__source">
+      {% include "partials/source.html" %}
+    </div>
+  {% endif %}
+  <ul class="md-nav__list" data-md-scrollfix>
+    {% include "partials/nav-top-btn.html" %}
+    {% for nav_item in nav %}
+      {% set path = "__nav_" ~ loop.index %}
+      {{ item.render(nav_item, path, 1) }}
+    {% endfor %}
+  </ul>
+</nav>

docs/docs/_themes/partials/source.html

@@ -0,0 +1,20 @@
+{#-
+  Copyright (c) 2016-2024 Martin Donath <martin[email protected]>
+  Copyright (c) 2024 Renesas Electronics Corporation and/or its affiliates
+  SPDX-License-Identifier: MIT
+
+  This code was originally taken from
+    https://github.com/squidfunk/mkdocs-material/blob/master/material/templates/partials/source.html
+  and have sources in
+    https://github.com/squidfunk/mkdocs-material/blob/master/src/templates/partials/source.html
+-#}
+
+<a href="{{ config.repo_url }}" title="{{ lang.t('source') }}" class="md-source" data-md-component="source" target="_blank">
+  <div class="md-source__icon md-icon">
+    {% set icon = config.theme.icon.repo or "fontawesome/brands/git-alt" %}
+    {% include ".icons/" ~ icon ~ ".svg" %}
+  </div>
+  <div class="md-source__repository">
+    {{ config.repo_name }}
+  </div>
+</a>