Add placeholder for doc versioning (#2931)

* Add placeholder for doc versioning

* Finalize module to include tags of verified releases only

doc/sphinx/conf.py

+
+
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Intel nGraph library documentation build configuration file, created by
+# sphinx-quickstart on Mon Dec 25 13:04:12 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+
+# Add path to nGraph Python API.
+
+sys.path.insert(0, os.path.abspath('../../../python'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+needs_sphinx = '1.7.5'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'breathe',
+    ]
+
+
+# source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+static_path = ['static']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'nGraph Compiler stack'
+copyright = '2018-2019, Intel Corporation'
+author = 'Intel Corporation'
+
+# License specifics see LICENSE of component
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.19'
+
+# The Documentation full version, including alpha/beta/rc tags. Some features
+# available in the latest code will not necessarily be documented first
+release = 'rc4'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+html_title = 'nGraph Compiler stack Documentation'
+
+html_theme = 'ngraph_theme'
+
+# html_theme_options = {}
+html_theme_path = ["../"]
+
+if tags.has('release'):
+    is_release = True
+    docs_title = 'Docs / %s' %(version) %(release)
+else:
+    is_release = False
+    docs_title = 'Docs / Latest'
+
+    # borrow this from the zephyr docs theme
+    html_context = {
+        # 'show_license': html_show_license, we have a custom footer to attribute WTD and Sphinx contributors
+        # so we do not enable this
+        'docs_title': docs_title,
+        'is_release': is_release,
+        'theme_logo_only': False,
+        'current_version': version,
+        'versions': ( ("latest", "/"),
+                     ("0.19.0", "/0.19.0/"),
+                     ("0.18.0", "/0.18.0/"),
+                     ("0.17.0", "/0.17.0/"),
+                     ("0.16.0", "/0.16.0/"),
+                     ("0.15.0", "/0.15.0/"),
+                    )
+    }
+
+
+
+html_logo = '../ngraph_theme/static/favicon.ico'
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+html_favicon = '../ngraph_theme/static/favicon.ico'
+
+# 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 = ['../ngraph_theme/static']
+
+# Add any paths that contain custom themes here, relative to this directory.
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'IntelnGraphlibrarydoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'nGraphCompilerStack.tex', 'nGraph Compiler Stack Documentation',
+     'Intel Corporation', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'ngraphcompiler', 'nGraph Compiler stack',
+     [author], 1)
+]
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'IntelnGraphlibrary', 'Intel nGraph Library',
+     author, 'IntelnGraphlibrary', 'Documentation for Intel nGraph Library code base',
+     'Miscellaneous'),
+]
+
+breathe_projects = {
+    "ngraph": "../../doxygen/xml",
+}
+
+rst_epilog = u"""
+.. |codename| replace:: Intel nGraph
+.. |project| replace:: Intel nGraph Library
+.. |InG| replace:: Intel® nGraph
+.. |nGl| replace:: nGraph library
+.. |copy|   unicode:: U+000A9 .. COPYRIGHT SIGN
+   :ltrim:
+.. |deg|    unicode:: U+000B0 .. DEGREE SIGN
+   :ltrim:
+.. |plusminus|  unicode:: U+000B1 .. PLUS-MINUS SIGN
+   :rtrim:
+.. |micro|  unicode:: U+000B5 .. MICRO SIGN
+   :rtrim:
+.. |trade|  unicode:: U+02122 .. TRADEMARK SIGN
+   :ltrim:
+.. |reg|    unicode:: U+000AE .. REGISTERED TRADEMARK SIGN
+   :ltrim:
+
+"""
+
+# -- autodoc Extension configuration --------------------------------------
+
+autodoc_mock_imports = ['ngraph.impl', 'ngraph.utils']

doc/sphinx/ngraph_theme/layout.html

@@ -119,6 +119,9 @@
           {% endblock %}
         </div>
 
+  {% include "ngversions.html" %}
+
+
         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
           {% block menu %}
             {% set toctree = toctree(maxdepth=2, collapse=theme_collapse_navigation, includehidden=True) %}
@@ -158,7 +161,6 @@
     </section>
 
   </div>
-  {% include "versions.html" %}
 
   {% if not embedded %}
 

doc/sphinx/ngraph_theme/ngversions.html

+  <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+    <span class="rst-current-version" data-toggle="rst-current-version">
+      <span class="docvs">nGraph Compiler stack</span>
+      v: {{ version }}           <dd><a href="../docs/latest">{{release}}</a></dd>
+      <span class="fa fa-caret-down"></span>
+    </span>
+    <div class="rst-other-versions">
+      <dl>
+        <dt>{{ _('Previous Verified Versions') }}</dt>
+        <dd><!-- Until our https://docs.ngraph.ai/ publishing is set up, we link to GitHub -->  
+          <ul>
+           <li><a href="https://github.com/NervanaSystems/ngraph/releases/tag/v0.18.1">0.18</a></li>
+           <li><a href="https://github.com/NervanaSystems/ngraph/releases/tag/v0.17.0-rc.1">0.17.0-rc.1</a></li>
+           <li><a href="https://github.com/NervanaSystems/ngraph/releases/tag/v0.16.0-rc.3">0.16.0-rc.3</a></li>
+           <li><a href="https://github.com/NervanaSystems/ngraph/releases/tag/v0.16.0-rc.2">0.16.0-rc.2</a></li>
+           <li><a href="https://github.com/NervanaSystems/ngraph/releases/tag/v0.16.0-rc.1">0.16.0-rc.1</a></li>
+         </ul></dd>
+      </dl>
+      <dl>
+        <dt>{{ _('Links') }}</dt>
+          <dd>
+           <a href="https://www.ngraph.ai/">Project Home</a>
+          </dd>
+          <dd>
+            <a href="https://github.com/NervanaSystems/ngraph/releases">All Releases</a>
+          </dd>
+      </dl>
+    </div>
+</div>
\ No newline at end of file

doc/sphinx/ngraph_theme/static/theme.css

@@ -2651,6 +2651,10 @@ div[class^='highlight'] pre {
   margin-right: 4px;
 }
 
+.rst-other-versions { display: list-item; }
+
+.docvs { font-weight: bolder; }
+
 .docbws {
   font-family: monospace;
   color: #A79992;
@@ -2756,6 +2760,7 @@ span[id*='MathJax-Span'] {
   line-height: 44.8px;
   padding: 0 1.618em;
   margin-bottom: 0;
+  margin-left: 0.003em;
   display: block;
   font-weight: bold;
   text-transform: uppercase;

doc/sphinx/ngraph_theme/versions.html

-{% if READTHEDOCS %}
-{# Add rst-badge after rst-versions for small badge style. #}
-  <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
-    <span class="rst-current-version" data-toggle="rst-current-version">
-      <span class="fa fa-book"> Read the Docs</span>
-      v: {{ current_version }}
-      <span class="fa fa-caret-down"></span>
-    </span>
-    <div class="rst-other-versions">
-      <dl>
-        <dt>Versions</dt>
-        {% for slug, url in versions %}
-          <dd><a href="{{ url }}">{{ slug }}</a></dd>
-        {% endfor %}
-      </dl>
-      <dl>
-        <dt>Downloads</dt>
-        {% for type, url in downloads %}
-          <dd><a href="{{ url }}">{{ type }}</a></dd>
-        {% endfor %}
-      </dl>
-      <dl>
-        <dt>On Read the Docs</dt>
-          <dd>
-            <a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">Project Home</a>
-          </dd>
-          <dd>
-            <a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">Builds</a>
-          </dd>
-      </dl>
-      <hr/>
-      Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
-
-    </div>
-  </div>
-{% endif %}
-

doc/sphinx/source/index.rst

@@ -84,9 +84,6 @@ boost compared to native implementations. For a high-level overview, see the
    :caption: Inspecting Graphs
 
    inspection/index.rst
-   inspection/performance-profile.rst
-   inspection/debug.rst 
-
 
 .. toctree::
    :maxdepth: 1

doc/sphinx/source/inspection/debug.rst

-.. debug:
-
-
-Debugging 
-#########
-
-
-Error hints
-===========
-
-
-Common mistakes
-===============
-
-
-Wiki, other help
-================
-
-
-
-

doc/sphinx/source/inspection/performance-profile.rst

-.. performance-profile:
-
-Performance profiling
-#####################
-
-
-.. FW-specific validation performance comparisons via nbench
\ No newline at end of file

doc/sphinx/source/project/index.rst

@@ -6,12 +6,12 @@ More about nGraph
 
 This section contains documentation about the project and how to contribute.
 
+
 .. toctree::
    :maxdepth: 2
 
    release-notes.rst
    about.rst
-   other-efforts.rst
    contribution-guide.rst
    governance.rst
    doc-contributor-README.rst

doc/sphinx/source/project/other-efforts.rst

-.. _other-efforts:
-
-Other notable efforts
-=====================

doc/sphinx/source/project/release-notes.rst

@@ -3,6 +3,11 @@
 Release Notes
 #############
 
+
+
+|version|
+|release|
+
 For downloads formatted as ``.zip`` and ``tar.gz``, see https://github.com/NervanaSystems/ngraph/releases; 
 
 .. important:: Pre-releases (``-rc-0.*``) have newer features, and are less stable.