update templates (#492)

update theme
update templates override and move them out of content dir
update config for moved templates

Fixes #490

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>

Co-authored-by: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com>

CI/requirements.txt

@@ -1,5 +1,5 @@
 mkdocs==1.1.2
-mkdocs-material==5.4.0
+mkdocs-material==5.5.6
 Markdown==3.2.1
 markdown-fenced-code-tabs==1.0.3
 markdown-include==0.5.1

custom_theme/partials/nav.html

@@ -0,0 +1,26 @@
+{#-
+This file was automatically generated - do not edit
+-#}
+<nav class="md-nav md-nav--primary" aria-label="{{ lang.t('nav.title') }}" data-md-level="0">
+  <label class="md-nav__title" for="__drawer">
+    <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" class="md-nav__button md-logo" aria-label="{{ config.site_name }}">
+      {% include "partials/logo.html" %}
+    </a>
+    <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}"
+       title="{{ config.site_name }}">
+      {{ config.site_name }}
+    </a>
+  </label>
+  {% if config.repo_url %}
+  <div class="md-nav__source">
+    {% include "partials/source.html" %}
+  </div>
+  {% endif %}
+  <ul class="md-nav__list" data-md-scrollfix>
+    {% for nav_item in nav %}
+    {% set path = "nav-" + loop.index | string %}
+    {% set level = 1 %}
+    {% include "partials/nav-item.html" %}
+    {% endfor %}
+  </ul>
+</nav>

docs/custom_theme/partials/nav.html

@@ -1,57 +0,0 @@
-<!--
-  Copyright (c) 2016-2019 Martin Donath <martin.donath@squidfunk.com>
-
-  Permission is hereby granted, free of charge, to any person obtaining a copy
-  of this software and associated documentation files (the "Software"), to
-  deal in the Software without restriction, including without limitation the
-  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-  sell copies of the Software, and to permit persons to whom the Software is
-  furnished to do so, subject to the following conditions:
-
-  The above copyright notice and this permission notice shall be included in
-  all copies or substantial portions of the Software.
-
-  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-  IN THE SOFTWARE.
--->
-
-<!-- Main navigation -->
-<nav class="md-nav md-nav--primary" data-md-level="0">
-
-  <!-- Site title -->
-  <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}"
-        title="{{ config.site_name }}" class="md-nav__button md-logo">
-      {% if config.theme.logo.icon %}
-        <i class="md-icon">{{ config.theme.logo.icon }}</i>
-      {% else %}
-        <img src="{{ config.theme.logo | url }}" width="48" height="48" />
-      {% endif %}
-    </a>
-    <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}"
-       title="{{ config.site_name }}">
-      {{ config.site_name }}
-    </a>
-  </label>
-
-  <!-- Repository containing source -->
-  {% if config.repo_url %}
-    <div class="md-nav__source">
-      {% include "partials/source.html" %}
-    </div>
-  {% endif %}
-
-  <!-- Render item list -->
-  <ul class="md-nav__list" data-md-scrollfix>
-    {% for nav_item in nav %}
-      {% set path = "nav-" + loop.index | string %}
-      {% set level = 1 %}
-      {% include "partials/nav-item.html" %}
-    {% endfor %}
-  </ul>
-</nav>

docs/custom_theme/partials/search.html

@@ -1,52 +0,0 @@
-<!--
-  Copyright (c) 2016-2019 Martin Donath <martin.donath@squidfunk.com>
-
-  Permission is hereby granted, free of charge, to any person obtaining a copy
-  of this software and associated documentation files (the "Software"), to
-  deal in the Software without restriction, including without limitation the
-  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-  sell copies of the Software, and to permit persons to whom the Software is
-  furnished to do so, subject to the following conditions:
-
-  The above copyright notice and this permission notice shall be included in
-  all copies or substantial portions of the Software.
-
-  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-  IN THE SOFTWARE.
--->
-
-{% import "partials/language.html" as lang with context %}
-
-<!-- Search interface -->
-<div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query"
-          placeholder="{{ lang.t('search.placeholder') }}"
-          autocapitalize="off" autocorrect="off" autocomplete="off"
-          spellcheck="false" data-md-component="query"
-          data-md-state="active" data-hj-whitelist />
-      <label class="md-icon md-search__icon" for="__search"></label>
-      <button type="reset" class="md-icon md-search__icon"
-          data-md-component="reset" tabindex="-1">
-        &#xE5CD;<!-- close -->
-      </button>
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result">
-          <div class="md-search-result__meta">
-            {{ lang.t("search.result.placeholder") }}
-          </div>
-          <ol class="md-search-result__list"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>

mkdocs.yml

@@ -42,7 +42,7 @@ repo_url: https://github.com/hyperledger/besu/
 
 theme:
     name: material
-    custom_dir: docs/custom_theme
+    custom_dir: custom_theme
     palette:
         primary: blue-grey
         accent: teal