From fec388032664f762469b6508377efce668490481 Mon Sep 17 00:00:00 2001
From: Deepak Khatri <lorforlinux@beagleboard.org>
Date: Thu, 1 Sep 2022 02:03:44 +0530
Subject: [PATCH] update layout
---
_templates/bversions.html | 27 +++++++++++++++++++++++++++
_templates/layout.html | 32 ++++++++++++++++++++++++++++++++
_templates/versions.html | 36 ------------------------------------
conf.py | 1 -
4 files changed, 59 insertions(+), 37 deletions(-)
create mode 100644 _templates/bversions.html
create mode 100644 _templates/layout.html
delete mode 100644 _templates/versions.html
diff --git a/_templates/bversions.html b/_templates/bversions.html
new file mode 100644
index 00000000..5b8c7401
--- /dev/null
+++ b/_templates/bversions.html
@@ -0,0 +1,27 @@
+{# Add rst-badge after rst-versions for small badge style. #}
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book"> BeagleBoard Project</span>
+ v: latest
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>{{ _('Document Release Versions') }}</dt>
+ {% for slug, url in versions %}
+ <dd><a href="{{ url }}">{{ slug }}</a></dd>
+ {% endfor %}
+ </dl>
+ <dl>
+ <dt>{{ _('Downloads') }}</dt>
+ {% set prefix = current_version if is_release else "latest" %}
+ <dd><a href="/{{ prefix }}/beagleboard-docs.pdf">PDF</a></dd>
+ </dl>
+ <dl>
+ <dt>{{ _('BeagleBoard.org Links') }}</dt>
+ <dd>
+ <a href="https://git.beagleboard.org/docs/docs.beagleboard.io/">Docs Source</a>
+ </dd>
+ </dl>
+ </div>
+ </div>
diff --git a/_templates/layout.html b/_templates/layout.html
new file mode 100644
index 00000000..998cb582
--- /dev/null
+++ b/_templates/layout.html
@@ -0,0 +1,32 @@
+{% extends "!layout.html" %}
+{% block document %}
+ {% if is_release %}
+ <div class="wy-alert wy-alert-danger">
+ The <a href="/latest/{{ pagename }}.html">latest development version</a>
+ of this page may be more current than this released {{ version }} version.
+ </div>
+ {% else %}
+ <div class="wy-alert wy-alert-danger">
+ This is the documentation for the latest (main) development branch of
+ BeagleBoard docs. If you are looking for the documentation of previous releases, use
+ the drop-down menu on the left and select the desired version.
+ </div>
+ {% endif %}
+ {{ super() }}
+{% endblock %}
+{% block menu %}
+ {% include "bversions.html" %}
+ {{ super() }}
+ {% if reference_links %}
+ <div class="toctree-wrapper compound">
+ <p class="caption"><span class="caption-text">Reference</span></p>
+ <ul>
+ {% for title, url in reference_links.items() %}
+ <li class="toctree-l1">
+ <a class="reference internal" href="{{ url }}">{{ title }}</a>
+ </li>
+ {% endfor %}
+ </ul>
+ </div>
+ {% endif %}
+{% endblock %}
diff --git a/_templates/versions.html b/_templates/versions.html
deleted file mode 100644
index b0b32adb..00000000
--- a/_templates/versions.html
+++ /dev/null
@@ -1,36 +0,0 @@
-{# Add rst-badge after rst-versions for small badge style. #}
- <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
- <span class="rst-current-version" data-toggle="rst-current-version">
- <span class="fa fa-book"> BeagleBoard Project</span>
- v: latest
- <span class="fa fa-caret-down"></span>
- </span>
- <div class="rst-other-versions">
- <dl>
- <dt>{{ _('Document Release Versions') }}</dt>
- {% for slug, url in versions %}
- <dd><a href="{{ pathto(master_doc)[:-1] }}{{ url }}">{{ slug }}</a></dd>
- {% endfor %}
-
- <dd><a href="{{ pathto(master_doc)[:-1] }}/">latest</a></dd>
- <dd><a href="{{ pathto(master_doc)[:-1] }}/0.0.7">0.0.7</a></dd>
- <dd><a href="{{ pathto(master_doc)[:-1] }}/0.1.0">0.1.0</a></dd>
- </dl>
- <dl>
- <dt>{{ _('Downloads') }}</dt>
- {% set version_prefix = current_version if is_release else "latest" %}
- <dd><a href="{{ pathto(master_doc)[:-1] }}{{version_prefix}}/beagleboard-docs.pdf">PDF</a></dd>
- <dd><a href="{{ pathto(master_doc)[:-1] }}/beagleboard-docs.pdf">PDF</a></dd>
- <dd><a href="{{ current_version }}{{version_prefix}}/beagleboard-docs.pdf">PDF</a></dd>
- <dd><a href="{{ current_version }}/beagleboard-docs.pdf">PDF</a></dd>
- <dd><a href="{{version_prefix}}/beagleboard-docs.pdf">PDF</a></dd>
- <dd><a href="beagleboard-docs.pdf">PDF</a></dd>
- </dl>
- <dl>
- <dt>{{ _('BeagleBoard.org Links') }}</dt>
- <dd>
- <a href="https://git.beagleboard.org/docs/docs.beagleboard.io/">Docs Source</a>
- </dd>
- </dl>
- </div>
- </div>
diff --git a/conf.py b/conf.py
index 52626826..0ac4de35 100644
--- a/conf.py
+++ b/conf.py
@@ -55,7 +55,6 @@ html_domain_indices = False
html_split_index = True
html_show_sourcelink = False
html_baseurl = 'docs.beagleboard.io'
-master_doc = "index"
# parse version from 'VERSION' file
with open(BBDOCS_BASE / "VERSION") as f:
--
GitLab