Update documentation

README.md

@@ -4,6 +4,7 @@ Python library and CLI for the INDIGO PaaS Orchestrator.
 
 * Free software: Apache License 2.0
 * Source: https://github.com/indigo-dc/orpy
+* Documentation: https://orpy.readthedocs.io/
 * Bugs: https://github.com/indigo-dc/orpy/issues
 
 ## Installation.

doc/source/_templates/sidebarfooter.html

@@ -0,0 +1,5 @@
+<hr/>
+<p style="font-size: 10px;">
+This software is part of the <a href="https://deep-hybrid-datacloud.eu">DEEP-Hybrid-DataCloud</a> project, that has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 777435.
+</p>
+

doc/source/api.rst

@@ -9,7 +9,7 @@ Orpy API bindings
    :caption: Contents:
 
 Orpy Client
-===========
+-----------
 
 Use this to interact with the INDIGO-DatatCloud orchestrator.
 

doc/source/conf.py

@@ -30,6 +30,9 @@
               'cliff.sphinxext',
               'reno.sphinxext']
 
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
@@ -66,24 +69,124 @@
 
 # -- Options for HTML output --------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-# html_theme_path = ["."]
-# html_theme = '_theme'
-# html_static_path = ['static']
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    'logo': 'logo.png',
+    'show_powered_by': False,
+    'github_user': 'indigo-dc',
+    'github_repo': 'orpy',
+    'github_banner': False,
+    'show_related': False,
+    'note_bg': '#FFF59C',
+    'description': 'Python bindings to the INDIGO-DataCloud PaaS Orchestrator API',
+}
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any paths that contain "extra" files, such as .htaccess or
+# robots.txt.
+html_extra_path = ['_extra']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+html_use_smartypants = False
+
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+#    'index':    ['sidebar.html', 'sourcelink.html', 'searchbox.html'],
+#    '**':       ['sidebar.html', 'localtoc.html', 'relations.html',
+#                 'sourcelink.html', 'searchbox.html'],
+    'index':       ['about.html', 'navigation.html', 'relations.html',
+                 'sourcelink.html', 'searchbox.html', 'sidebarfooter.html'],
+}
+
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+html_show_copyright = 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.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = '%sdoc' % project
+htmlhelp_basename = 'DEEPaaSdoc'
+
+# -- Options for LaTeX output -------------------------------------------------
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-    ('index',
-     '%s.tex' % project,
-     u'%s Documentation' % project,
-     u'Alvaro Lopez Garcia', 'manual'),
+    ('index', 'deepaas.tex', u'DEEPaaS Documentation',
+     author, 'manual'),
 ]
 
-# Example configuration for intersphinx: refer to the Python standard library.
-#intersphinx_mapping = {'http://docs.python.org/': None}
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+latex_logo = "_static/logo.png"
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True

doc/source/releasenotes/index.rst

@@ -2,7 +2,7 @@ Orpy Release Notes
 ==================
 
 Current (un)Release Notes
----------------------
+-------------------------
 
 .. release-notes::