summaryrefslogtreecommitdiffstats
path: root/docs/_templates
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2019-05-15 16:10:18 -0400
committerRich Bennett <rb2745@att.com>2019-05-15 20:14:56 -0400
commit075cab7dceb632b3d82786fa0212e7b5f852a0ea (patch)
treeda482edc97c7b32f9af4a7106566c79f86eda272 /docs/_templates
parent26f44476e6b61fca34e1e72ea8a65cebf8ed1905 (diff)
First commit to dublin branch
Add default branch to .gitreview Switch sphinx theme to bootstrap with bootswatch lumen style Reuse OPENDAYLIGHT/OPNFV side navbar templates Remove unused options in conf.py and add the License text Begin to use the lfit/releng global doc project template Add TODO for guidelines on use of the new theme Update submodule references for contributing repositories that already have a dublin branch Change-Id: I60c26a25bd15b90ab4878b0635ebd9b9d8712a0d Issue-ID: DOC-467 Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/_templates')
-rw-r--r--docs/_templates/navbar.html76
-rw-r--r--docs/_templates/relations.html16
2 files changed, 92 insertions, 0 deletions
diff --git a/docs/_templates/navbar.html b/docs/_templates/navbar.html
new file mode 100644
index 000000000..41f5c8181
--- /dev/null
+++ b/docs/_templates/navbar.html
@@ -0,0 +1,76 @@
+<div id="navbar" class="{{ theme_navbar_class }} navbar-default {% if theme_navbar_fixed_top|tobool -%} navbar-fixed-top{%- endif -%}">
+ <!-- Outdated version warning banner -->
+ {% if version_status == 'unsupported' %}
+ <div id="unsupported_warning" >
+ This document is for a release of ONAP that is no longer supported.
+ </div>
+ <style>
+ body {
+ padding-top: 110px;
+ }
+ </style>
+ {% elif version_status == 'deprecated' %}
+ <div id="deprecated_warning" >
+ This document is for a deprecated release of ONAP and will receive only security updates.
+ </div>
+ <style>
+ body {
+ padding-top: 110px;
+ }
+ </style>
+ {% else %}
+ <style>
+ body {
+ padding-top: 60px;
+ }
+ </style>
+ {% endif %}
+ <div class="container">
+ <div class="navbar-header">
+ <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="{{ pathto(master_doc) }}">
+ {%- block sidebarlogo %}
+ {%- if logo %}<span><img src="{{ pathto('_static/' + logo, 1) }}"></span>{%- endif %}
+ {%- endblock %}
+ {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}{%- endif -%}
+ </a>
+ <span class="navbar-text navbar-version pull-left"><b>{{ version|e }}</b></span>
+ </div>
+
+ <div class="collapse navbar-collapse nav-collapse">
+ <ul class="nav navbar-nav">
+ {% if theme_navbar_links %}
+ {%- for link in theme_navbar_links %}
+ <li><a href="{{ pathto(*link[1:]) }}">{{ link[0] }}</a></li>
+ {%- endfor %}
+ {% endif %}
+ {% block navbartoc %}
+ {% include "globaltoc.html" %}
+ {% if theme_navbar_pagenav %}
+ {% include "navbartoc.html" %}
+ {% endif %}
+ {% endblock %}
+ {% if theme_navbar_sidebarrel %}
+ {% block sidebarrel %}
+ {% include "relations.html" %}
+ {% endblock %}
+ {% endif %}
+ {% block navbarextra %}
+ {% endblock %}
+ {% if theme_source_link_position == "nav" %}
+ <li class="hidden-sm">{% include "sourcelink.html" %}</li>
+ {% endif %}
+ </ul>
+
+ {% block navbarsearch %}
+ {% include "navbarsearchbox.html" %}
+ {% endblock %}
+ </div>
+ </div>
+ </div>
+
diff --git a/docs/_templates/relations.html b/docs/_templates/relations.html
new file mode 100644
index 000000000..c701ed0c0
--- /dev/null
+++ b/docs/_templates/relations.html
@@ -0,0 +1,16 @@
+<center>
+<div class="btn-group" role="group" aria-label="...">
+ {% if prev %}
+ <a class="btn btn-default" href="{{ prev.link|e }}">Prev Page</a>
+ {% else %}
+ <button type="button" class="btn btn-default disabled">Prev Page</button>
+ {% endif %}
+
+ {% if next %}
+ <a class="btn btn-default" href="{{ next.link|e }}">Next Page</a>
+ {% else %}
+ <button type="button" class="btn btn-default disabled">Next Page</button>
+ {% endif %}
+</div>
+</center>
+