Improve the documentation sidebar and footer (#186)

PHP-CMSIG · May 15, 2023 · be611c1 · be611c1
1 parent ed16c07
commit be611c1
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 6 deletions.
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -59,3 +59,25 @@ article table th {
     display: block;
     margin: 0 auto;
 }
+
+.sidebar-logo {
+    max-width: 80px;
+}
+
+.sidebar-brand-text {
+    font-size: 0;
+    display: block;
+    font-weight: 500;
+}
+
+.sidebar-brand-text::before {
+    content: "SEAL";
+    font-size: 20px;
+}
+
+.sidebar-brand-text::after {
+    display: block;
+    content: "Search Engine Abstraction Layer";
+    padding-top: 6px;
+    font-size: 12px;
+}
diff --git a/docs/_static/icons/logo.png b/docs/_static/icons/logo.png
diff --git a/docs/_templates/page.html b/docs/_templates/page.html
@@ -5,13 +5,21 @@
 
     {% if display_github %}
         <div style="padding-bottom: 32px;">
-            <a class="muted-link" target="_blank" href="https://github.com/{{ github_user }}/{{ github_repo }}/edit/{{ github_version }}{{ conf_py_path }}{{ pagename }}.rst" style="font-size: 12px; display: inline-flex; gap: 8px; align-items: center;">
-                Edit on Github
+            <div style="margin-left: auto; font-size: 12px;">
+                Created with support in the austrian alps at <a href="https://github.com/sulu/sulu"><b>Sulu CMS</b></a>.
+            </div>
 
-                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16" style="width: 16px;">
-                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
-                </svg>
-            </a>
+            <br>
+
+            <div>
+                <a class="muted-link" target="_blank" href="https://github.com/{{ github_user }}/{{ github_repo }}/edit/{{ github_version }}{{ conf_py_path }}{{ pagename }}.rst" style="font-size: 12px; display: inline-flex; gap: 8px; align-items: center;">
+                    Edit on Github
+
+                    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16" style="width: 16px;">
+                        <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                    </svg>
+                </a>
+            </div>
         </div>
     {% endif %}
 {% endblock %}
diff --git a/docs/conf.py b/docs/conf.py
@@ -11,7 +11,9 @@
 author = 'Alexander Schranz'
 release = '0.1'
 html_title = 'SEAL Documentation'
+html_short_title = 'SEAL'
 html_favicon = '_static/icons/favicon.ico'
+html_logo = '_static/icons/logo.png'
 
 html_context = {
     "display_github": True, # Integrate GitHub