Browse Source
We've replaced the "zephyr-docs" theme with a simpler read-the-docs theme starting with the 1.13 release. This PR retrofits the theme changes back onto this 1.9 release and ignores attempts to use the zephyr-docs theme controlled by the make DOC_TAGS option. Also needed to backport changes to the warning filtering system implemented in later releases, fixes to how the config options were generated (genrest.py). Signed-off-by: David B. Kinder <david.b.kinder@intel.com>v1.9-branch
David B. Kinder
7 years ago
committed by
Anas Nashif
16 changed files with 297 additions and 27 deletions
@ -0,0 +1,6 @@
@@ -0,0 +1,6 @@
|
||||
# |
||||
^(?P<filename>([-:\\/\w\.])+[/\\]doc[/\\]api[/\\]file_system.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration. |
||||
# |
||||
^(?P<filename>([-:\\/\w\.])+[/\\]doc[/\\]api[/\\]io_interfaces.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration. |
||||
# |
||||
^(?P<filename>([-:\\/\w\.])+[/\\]doc[/\\]subsystems[/\\]sensor.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration. |
||||
@ -0,0 +1,14 @@
@@ -0,0 +1,14 @@
|
||||
{% extends "!breadcrumbs.html" %} |
||||
{% block breadcrumbs %} |
||||
<!-- {{ docs_title }} --> |
||||
{# parameterize default name "Docs" in breadcrumb via docs_title in conf.py #} |
||||
{% if not docs_title %} |
||||
{% set docs_title = "Docs" %} |
||||
{% endif %} |
||||
|
||||
<li><a href="{{ pathto(master_doc) }}">{{ docs_title }}</a> »</li> |
||||
{% for doc in parents %} |
||||
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li> |
||||
{% endfor %} |
||||
<li>{{ title }}</li> |
||||
{% endblock %} |
||||
@ -0,0 +1,10 @@
@@ -0,0 +1,10 @@
|
||||
{% extends "!layout.html" %} |
||||
{% block document %} |
||||
{% if is_release %} |
||||
<div class="wy-alert wy-alert-danger"> |
||||
The <a href="/{{ pagename }}.html">latest development version</a> |
||||
of this page may be more current than this released {{ version }} version. |
||||
</div> |
||||
{% endif %} |
||||
{{ super() }} |
||||
{% endblock %} |
||||
@ -0,0 +1,28 @@
@@ -0,0 +1,28 @@
|
||||
{# 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"> Zephyr Project</span> |
||||
v: {{ current_version }} |
||||
<span class="fa fa-caret-down"></span> |
||||
</span> |
||||
<div class="rst-other-versions"> |
||||
<dl> |
||||
<dt>{{ _('Versions') }}</dt> |
||||
{% for slug, url in versions %} |
||||
<dd><a href="{{ url }}">{{ slug }}</a></dd> |
||||
{% endfor %} |
||||
</dl> |
||||
<dl> |
||||
<dt>{{ _('On zephyrproject.org') }}</dt> |
||||
<dd> |
||||
<a href="https://www.zephyrproject.org/">Project Home</a> |
||||
</dd> |
||||
<dd> |
||||
<a href="https://www.zephyrproject.org/developers/#downloads">Downloads</a> |
||||
</dd> |
||||
<dd> |
||||
<a href="https://github.com/zephyrproject-rtos/zephyr/releases">Releases</a> |
||||
</dd> |
||||
</dl> |
||||
</div> |
||||
</div> |
||||
|
After Width: | Height: | Size: 27 KiB |
|
After Width: | Height: | Size: 534 B |
@ -0,0 +1,40 @@
@@ -0,0 +1,40 @@
|
||||
#!/bin/bash |
||||
|
||||
# run the filter-known-issues.py script to remove "expected" warning |
||||
# messages from the output of the document build process and write |
||||
# the filtered output to stdout |
||||
# |
||||
# Only argument is the name of the log file saved by the build. |
||||
|
||||
KI_SCRIPT=${ZEPHYR_BASE}/scripts/filter-known-issues.py |
||||
CONFIG_DIR=${ZEPHYR_BASE}/.known-issues/doc |
||||
|
||||
LOG_FILE=$1 |
||||
|
||||
red='\E[31m' |
||||
green='\e[32m' |
||||
|
||||
if [ -z "${LOG_FILE}" ]; then |
||||
echo "Error in $0: missing input parameter <logfile>" |
||||
exit 1 |
||||
fi |
||||
|
||||
if [ -s "${LOG_FILE}" ]; then |
||||
$KI_SCRIPT --config-dir ${CONFIG_DIR} ${LOG_FILE} > doc.warnings 2>&1 |
||||
if [ -s doc.warnings ]; then |
||||
echo |
||||
echo -e "${red}New errors/warnings found, please fix them:" |
||||
echo -e "==============================================" |
||||
tput sgr0 |
||||
echo |
||||
cat doc.warnings |
||||
echo |
||||
else |
||||
echo -e "${green}No new errors/warnings." |
||||
tput sgr0 |
||||
fi |
||||
|
||||
else |
||||
echo "Error in $0: logfile \"${LOG_FILE}\" not found." |
||||
exit 1 |
||||
fi |
||||
@ -0,0 +1,6 @@
@@ -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"); |
||||
}); |
||||
Loading…
Reference in new issue