Commit e1deaf58 authored by David B. Kinder's avatar David B. Kinder Committed by Anas Nashif
Browse files

doc: update 1.12 release with RTD theme



We've replaced the "zephyr-docs" theme with a simpler read-the-docs
thema starting with the 1.13 release.  This PR retrofits the theme
changes back onto this 1.12 release and ignores attempts to use the
zephyr-docs theme controlled by the make DOC_TAGS option.

Signed-off-by: default avatarDavid B. Kinder <david.b.kinder@intel.com>
parent f58d9cab
Loading
Loading
Loading
Loading
+6 −0
Original line number Diff line number Diff line
#
^(?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.
+14 −0
Original line number Diff line number Diff line
{% 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> &raquo;</li>
  {% for doc in parents %}
     <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
  {% endfor %}
  <li>{{ title }}</li>
{% endblock %}
+10 −0
Original line number Diff line number Diff line
{% 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 %}
+28 −0
Original line number Diff line number Diff line
{# 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>
+15 −16
Original line number Diff line number Diff line
@@ -145,20 +145,10 @@ rst_epilog = """

# -- Options for HTML output ----------------------------------------------

try:
import sphinx_rtd_theme
except ImportError:
    html_theme = 'zephyr'
    html_theme_path = ['./themes']
else:
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

if tags.has('daily') or tags.has('release'):
    html_theme = 'zephyr-docs-theme'
    html_theme_path = ['./themes']


if tags.has('release'):
    is_release = True
    docs_title = 'Docs / %s' %(version)
@@ -179,12 +169,12 @@ html_title = "Zephyr Project Documentation"

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = 'images/Zephyr-Kite-logo.png'

# 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
# pixels large.
#html_favicon = None
html_favicon = 'images/zp_favicon.png'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@@ -221,7 +211,7 @@ html_use_index = True
html_split_index = True

# 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.
html_show_sphinx = False
@@ -359,6 +349,14 @@ html_context = {
    'show_license': html_show_license,
    'docs_title': docs_title,
    'is_release': is_release,
    'theme_logo_only': False,
    'current_version': version,
    'versions': ( ("latest", "/"),
                 ("1.12.0", "/1.12.0/"),
                 ("1.11.0", "/1.11.0/"),
                 ("1.10.0", "/1.10.0/"),
                 ("1.9.2", "/1.9.0/"),
                )
}

extlinks = {'jira': ('https://jira.zephyrproject.org/browse/%s', ''),
@@ -379,3 +377,4 @@ linkcheck_anchors = False

def setup(app):
   app.add_stylesheet("zephyr-custom.css")
   app.add_javascript("zephyr-custom.js")
Loading