doc: Change conf.py and index.rst to fix the copyright and license.

Removes permalinks and sets the correct version and release. The change places
the copyright notice and license in the footer of every page.
Both copyright and license do not appear in the website's version.

Change-Id: Idb5171b24af004fc2f7aff42aab43469f26305b4
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Rodrigo Caballero 2015-10-16 09:30:15 -05:00 committed by Anas Nashif
commit 8d7b52f146
4 changed files with 43 additions and 18 deletions

View file

@ -49,7 +49,7 @@ master_doc = 'index'
# General information about the project.
project = u'Zephyr Project'
copyright = u'2015, Intel Corporation, Wind River Systems, Inc.'
copyright = u'2015, Intel Corporation, Wind River Systems, Inc'
author = u'many'
# The version info for the project you're documenting, acts as replacement for
@ -57,9 +57,9 @@ author = u'many'
# built documents.
#
# The short X.Y version.
version = '0.1'
version = '0.6.0-rc1'
# The full version, including alpha/beta/rc tags.
release = '0.1'
release = 'R-0.6.0-rc1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -128,6 +128,10 @@ html_theme_path = ['./themes']
# "<project> v<release> documentation".
html_title = "Zephyr Project Documentation"
# If True permalinks will be added to each header.
html_add_permalinks = False
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
@ -178,11 +182,14 @@ html_split_index = True
#html_show_sourcelink =
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = True
# If true, license is shown in the HTML footer. Default is True.
html_show_license = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
@ -294,3 +301,7 @@ breathe_projects = {
"doc-examples": "xml"
}
breathe_default_project = "Zephyr"
html_context = {
'show_license': html_show_license,
}

View file

@ -1,10 +0,0 @@
.. raw:: html
<a rel="license"
href="http://creativecommons.org/licenses/by/4.0/"><img
alt="Creative Commons License" style="border-width:0"
src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br
/>This work is licensed under a <a rel="license"
href="http://creativecommons.org/licenses/by/4.0/">Creative Commons
Attribution 4.0 International License</a>

View file

@ -1,8 +1,6 @@
..
Zephyr Project documentation master file
Getting Started
###############
@ -39,5 +37,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`search`
.. include:: documentation_license.rst

View file

@ -12,3 +12,31 @@
{# put the sidebar before the body #}
{% block sidebar1 %}{{ sidebar() }}{% endblock %}
{% block sidebar2 %}{% endblock %}
{%- block footer %}
<div class="footer" role="contentinfo">
{%- if show_license %}
<a rel="license"
href="http://creativecommons.org/licenses/by/4.0/"> <img alt="Creative
Commons License" style="border-width:0; height: 12px"
src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a> This work
is licensed under a <a rel="license"
href="http://creativecommons.org/licenses/by/4.0/">Creative Commons
Attribution 4.0 International License</a> -
{%- endif %}
{%- if show_copyright %}
{%- if hasdoc('copyright') %}
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{%
endtrans %}
{%- else %}
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
{%- endif %}
{%- endif %}
{%- if last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- endif %}
{%- if show_sphinx %}
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.
{% endtrans %}
{%- endif %}
</div>
{%- endblock %}