From 8d7b52f146c3f50c5f7412d08b36c3dce2810711 Mon Sep 17 00:00:00 2001 From: Rodrigo Caballero Date: Fri, 16 Oct 2015 09:30:15 -0500 Subject: [PATCH] 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 Signed-off-by: Anas Nashif --- doc/conf.py | 19 +++++++++++++++---- doc/documentation_license.rst | 10 ---------- doc/index.rst | 4 ---- doc/themes/zephyr/layout.html | 28 ++++++++++++++++++++++++++++ 4 files changed, 43 insertions(+), 18 deletions(-) delete mode 100644 doc/documentation_license.rst diff --git a/doc/conf.py b/doc/conf.py index 4220cf871c5..414886ec440 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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'] # " v 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 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, +} diff --git a/doc/documentation_license.rst b/doc/documentation_license.rst deleted file mode 100644 index dc9938495b3..00000000000 --- a/doc/documentation_license.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. raw:: html - - Creative Commons License
This work is licensed under a Creative Commons - Attribution 4.0 International License - diff --git a/doc/index.rst b/doc/index.rst index 60658a6cd4b..c23ec0036f5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 diff --git a/doc/themes/zephyr/layout.html b/doc/themes/zephyr/layout.html index f5c29668f35..4e7caa0b72e 100644 --- a/doc/themes/zephyr/layout.html +++ b/doc/themes/zephyr/layout.html @@ -12,3 +12,31 @@ {# put the sidebar before the body #} {% block sidebar1 %}{{ sidebar() }}{% endblock %} {% block sidebar2 %}{% endblock %} +{%- block footer %} + +{%- endblock %}