doc: more RTD theme tweaks

Change logo and increase logo size, remove RTD links to github source,
add CSS for :kbd: role (keyboard key press), change logo link to project
home rather than doc home (via zephyr-custom.js). Update 404 error page
for wider page layout, force page break before footer, show URL that got
you to the 404 page.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-07-31 13:47:10 -07:00 committed by Anas Nashif
commit f3f266ea9d
7 changed files with 50 additions and 7 deletions

View file

@ -5,15 +5,26 @@ Sorry, Page Not Found
.. image:: images/Zephyr-Kite-in-tree.png .. image:: images/Zephyr-Kite-in-tree.png
:align: right :align: right
:scale: 30 % :scale: 25%
Sorry, the page you requested was not found on this site. .. raw:: html
<noscript>
Sorry, the page you requested was not found on this site.
</noscript>
<script type="text/javaScript">
<!--
document.write("<p>Sorry, the page you requested: " +
"<a href=\"" + location.href + "\">" +
location.href + "</a> was not found on this site.</p>");
//-->
</script>
Please check the url for misspellings. Please check the url for misspellings.
It's also possible we've removed or renamed the page you're looking for. It's also possible we've removed or renamed the page you're looking for.
Please try using the links at the top and left of the page, to navigate Please try using the navigation links on the left of this page to navigate
the major sections of our site, or use the search box. the major sections of our site, or use the search box.
If you got this error by following a link, please let us know by sending If you got this error by following a link, please let us know by sending
@ -21,3 +32,7 @@ us a message using this `contact us form`_, or send an email message to
info@zephyrproject.org info@zephyrproject.org
.. _contact us form: https://www.zephyrproject.org/about/#contact-us .. _contact us form: https://www.zephyrproject.org/about/#contact-us
.. raw:: html
<div style='clear:both'></div>

View file

@ -183,7 +183,7 @@ html_title = "Zephyr Project Documentation"
# The name of an image file (relative to this directory) to place at the top # The name of an image file (relative to this directory) to place at the top
# of the sidebar. # of the sidebar.
html_logo = 'images/zephyr_logo_line_small.png' html_logo = 'images/Zephyr-Kite-logo.png'
# The name of an image file (within the static path) to use as favicon of the # The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
@ -225,7 +225,7 @@ html_use_index = True
html_split_index = True html_split_index = True
# If true, links to the reST sources are added to the pages. # If true, links to the reST sources are added to the pages.
#html_show_sourcelink = html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False html_show_sphinx = False
@ -363,7 +363,7 @@ html_context = {
'show_license': html_show_license, 'show_license': html_show_license,
'docs_title': docs_title, 'docs_title': docs_title,
'is_release': is_release, 'is_release': is_release,
'theme_logo_only': True, 'theme_logo_only': False,
'current_version': version, 'current_version': version,
'versions': ( ("latest", "/"), 'versions': ( ("latest", "/"),
("1.12.0", "/1.12.0/"), ("1.12.0", "/1.12.0/"),
@ -391,3 +391,4 @@ linkcheck_anchors = False
def setup(app): def setup(app):
app.add_stylesheet("zephyr-custom.css") app.add_stylesheet("zephyr-custom.css")
app.add_javascript("zephyr-custom.js")

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.1 KiB

View file

@ -133,3 +133,24 @@ th,td {
col.option { col.option {
width: 25%; width: 25%;
} }
/* tweak format for <kbd> (:kbd:`F10`) */
kbd
{
-moz-border-radius:3px;
-moz-box-shadow:0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
-webkit-border-radius:3px;
-webkit-box-shadow:0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
background-color:#f7f7f7;
border:1px solid #ccc;
border-radius:3px;
box-shadow:0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
color:#333;
display:inline-block;
font-family:Arial,Helvetica,sans-serif;
font-size:11px;
line-height:1.4;
margin:0 .1em;
padding:.1em .6em;
text-shadow:0 1px 0 #fff;
}

6
doc/static/zephyr-custom.js vendored Normal file
View file

@ -0,0 +1,6 @@
/* tweak logo link to the project home page in a new tab*/
$(document).ready(function(){
$( ".icon-home" ).attr("href", "https://zephyrproject.org/");
$( ".icon-home" ).attr("target", "_blank");
});

View file

@ -5,6 +5,6 @@
build folder. This .rst file tricks the script to reference file build folder. This .rst file tricks the script to reference file
that are mentioned in the conf.py file but not in any .rst file that are mentioned in the conf.py file but not in any .rst file
.. image:: images/zephyr_logo_line_small.png .. image:: images/Zephyr-Kite-logo.png
.. image:: images/zp_favicon.png .. image:: images/zp_favicon.png
.. include:: _templates/versions.html .. include:: _templates/versions.html