Add link to download PDF of documentation

This commit adds a sidebar box with a link to the
Fuel Development documentation in the form of a
PDF.  The PDF document will be built automatically
by Jenkins when the docs are built.

Change-Id: I45a07043340b50c24dadee8143a3e475c239d545
Implements: blueprint fuel-web-docs-dev-env-restructure
This commit is contained in:
Christopher Aedo 2014-06-24 14:03:33 -07:00
parent 432c1d40d8
commit 14dcbfa14b
3 changed files with 18 additions and 1 deletions

12
docs/_templates/searchbox.html vendored Normal file
View File

@ -0,0 +1,12 @@
{%- if pagename != "search" %}
<h3>Quick search</h3>
<form class="navbar-search pull-right" style="margin-bottom:-3px;" action="{{ pathto('search') }}" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</form>
{%- endif %}

3
docs/_templates/sidebarpdf.html vendored Normal file
View File

@ -0,0 +1,3 @@
<h3>Downloadable PDF</h3>
<a href="http://docs.mirantis.com/fuel-dev/pdf/Fuel.pdf"
rel="nofollow">Fuel Development Documentation</a>

View File

@ -143,7 +143,9 @@ html_theme_path = ["_templates"]
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
html_sidebars = {
'**': ['localtoc.html', 'relations.html', 'sourcelink.html', 'sidebarpdf.html', 'searchbox.html'],
}
# Additional templates that should be rendered to pages, maps page names to
# template names.