diff options
author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-07 12:44:48 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:34 +0100 |
commit | ad2e3e614696e098cb4ab1791cb402adaa16d033 (patch) | |
tree | 4f569bf5a63f66797c5ffb1bcd21e0f1894de377 /documentation/_templates | |
parent | 721edcfd44a61c4ea7a88d4e46d35bbdbce99c56 (diff) | |
download | poky-ad2e3e614696e098cb4ab1791cb402adaa16d033.tar.gz |
sphinx: Add support for multiple docs version
Enhance the sphinx experience/nagivation with:
* Remove the pointless looking parts of breadcrumb navigtation
* Add a document type switcher to the breadcrumb navigation
* Add a version selection switch to the breadcrumb navigation
(From yocto-docs rev: 1823624bdb9ea002d44c9e6d0fd4cd662bff36ad)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/_templates')
-rw-r--r-- | documentation/_templates/breadcrumbs.html | 14 | ||||
-rw-r--r-- | documentation/_templates/layout.html | 9 |
2 files changed, 23 insertions, 0 deletions
diff --git a/documentation/_templates/breadcrumbs.html b/documentation/_templates/breadcrumbs.html new file mode 100644 index 0000000000..eb6244b74c --- /dev/null +++ b/documentation/_templates/breadcrumbs.html | |||
@@ -0,0 +1,14 @@ | |||
1 | {% extends "!breadcrumbs.html" %} | ||
2 | |||
3 | {% block breadcrumbs %} | ||
4 | <li> | ||
5 | <span class="doctype_switcher_placeholder">{{ doctype or 'single' }}</span> | ||
6 | <span class="version_switcher_placeholder">{{ release }}</span> | ||
7 | </li> | ||
8 | <li> »</li> | ||
9 | {% for doc in parents %} | ||
10 | <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li> | ||
11 | {% endfor %} | ||
12 | <li>{{ title }}</li> | ||
13 | {% endblock %} | ||
14 | |||
diff --git a/documentation/_templates/layout.html b/documentation/_templates/layout.html new file mode 100644 index 0000000000..af4c6acc60 --- /dev/null +++ b/documentation/_templates/layout.html | |||
@@ -0,0 +1,9 @@ | |||
1 | {% extends "!layout.html" %} | ||
2 | |||
3 | {% set script_files = script_files + ['_static/switchers.js'] %} | ||
4 | |||
5 | {% block extrabody %} | ||
6 | <div id="outdated-warning" style="text-align: center; background-color: #FFBABA; color: #6A0E0E;"> | ||
7 | </div> | ||
8 | {% endblock %} | ||
9 | |||