Skip to content

N
ngraph
Commit 9e34172a authored by Leona C's avatar Leona C Committed by Scott Cyphers
Browse files
Options

Tested doc build for 0.27 with sitemap for ngraph.ai endpoint (#4014) 

* Make sure examples compile

* Resolve doc build error due to opset versioning and align dynamic tensor doc to cpp example

* Add latest rc

* Remove deprecated API

* Update brief link summary

* Dist example

* update doc for cpp code examples folder

* Fix typo and toc index

* Build config for example, deprecation in dist test

* style

* Sitemap for ngraph.ai doc content

* Add title to sitemap

* resolve docbuild warnings resultant from sitemap link labeling

* Doc tag for 0.27.1
parent 5cc8690b
Hide whitespace changes
Inline Side-by-side
Showing with 96 additions and 209 deletions
doc/sphinx/ngraph_theme/layout_old.html deleted 100644 → 0
View file @ 5cc8690b
{#
basic/layout.html
~~~~~~~~~~~~~~~~~
Master layout template for Sphinx themes.
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- block doctype -%}
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
{%- endblock %}
{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
(sidebars != []) %}
{%- set url_root = pathto('', 1) %}
{# XXX necessary? #}
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
{%- if not embedded and docstitle %}
{%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
{%- else %}
{%- set titlesuffix = "" %}
{%- endif %}
{%- macro relbar() %}
<div class="related">
<h3>{{ _('Navigation') }}</h3>
<ul>
{%- for rellink in rellinks %}
<li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
{%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
{%- endfor %}
{%- block rootrellink %}
<li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
{%- endblock %}
{%- for parent in parents %}
<li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
{%- endfor %}
{%- block relbaritems %} {% endblock %}
</ul>
</div>
{%- endmacro %}
{%- macro sidebar() %}
{%- if render_sidebar %}
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
{%- block sidebarlogo %}
{%- if logo %}
<p class="logo"><a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
</a></p>
{%- endif %}
{%- endblock %}
{%- if sidebars != None %}
{#- new style sidebar: explicitly include/exclude templates #}
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
{%- else %}
{#- old style sidebars: using blocks -- should be deprecated #}
{%- block sidebartoc %}
{%- include "localtoc.html" %}
{%- endblock %}
{%- block sidebarrel %}
{%- include "relations.html" %}
{%- endblock %}
{%- block sidebarsourcelink %}
{%- include "sourcelink.html" %}
{%- endblock %}
{%- if customsidebar %}
{%- include customsidebar %}
{%- endif %}
{%- block sidebarsearch %}
{%- include "searchbox.html" %}
{%- endblock %}
{%- endif %}
</div>
</div>
{%- endif %}
{%- endmacro %}
{%- macro script() %}
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '{{ url_root }}',
VERSION: '{{ release|e }}',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }}
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{%- endmacro %}
{%- macro css() %}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
{%- for cssfile in css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{%- endfor %}
{%- endmacro %}
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
{{ metatags }}
{%- block htmltitle %}
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
{%- endblock %}
{{ css() }}
{%- if not embedded %}
{{ script() }}
{%- if use_opensearch %}
<link rel="search" type="application/opensearchdescription+xml"
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
{%- endif %}
{%- if favicon %}
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
{%- endif %}
{%- endif %}
{%- block linktags %}
{%- if hasdoc('about') %}
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
{%- endif %}
{%- if hasdoc('genindex') %}
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
{%- endif %}
{%- if hasdoc('search') %}
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
{%- endif %}
{%- if hasdoc('copyright') %}
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
{%- endif %}
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
{%- if parents %}
<link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
{%- endif %}
{%- if next %}
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
{%- endif %}
{%- if prev %}
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
{%- endif %}
{%- endblock %}
{%- block extrahead %} {% endblock %}
</head>
<body>
{%- block header %}{% endblock %}
{%- block relbar1 %}{{ relbar() }}{% endblock %}
{%- block content %}
{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
<div class="document">
{%- block document %}
<div class="documentwrapper">
{%- if render_sidebar %}
<div class="bodywrapper">
{%- endif %}
<div class="body">
{% block body %} {% endblock %}
</div>
{%- if render_sidebar %}
</div>
{%- endif %}
</div>
{%- endblock %}
{%- block sidebar2 %}{{ sidebar() }}{% endblock %}
<div class="clearer"></div>
</div>
{%- endblock %}
{%- block relbar2 %}{{ relbar() }}{% endblock %}
{%- block footer %}
<div class="footer">
{%- 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>
<p>asdf asdf asdf asdf 22</p>
{%- endblock %}
</body>
</html>
doc/sphinx/ngraph_theme/ngversions.html
View file @ 9e34172a
......@@ -9,6 +9,7 @@
<dt>{{ _('Recent Versions') }}<i class="fa fa-terminal"></i></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.27.1-rc.1">0.27.1</a></li>
<li><a href="https://github.com/NervanaSystems/ngraph/releases/tag/v0.27.0-rc.1">0.27.0</a></li>
<li><a href="https://github.com/NervanaSystems/ngraph/releases/tag/v0.26.0">0.26.0</a></li>
<li><a href="https://github.com/NervanaSystems/ngraph/releases/tag/v0.25.1-rc.10">0.25.1</a></li>
......
doc/sphinx/source/backends/index.rst
View file @ 9e34172a
.. backends/index.rst
.. _backend_support:
#####################
Working with Backends
#####################
......
doc/sphinx/source/conf.py
View file @ 9e34172a
......@@ -77,7 +77,7 @@ version = '0.27'
# The Documentation full version, including alpha/beta/rc tags. Some features
# available in the latest code will not necessarily be documented first
release = '0.27.0'
release = '0.27.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......
doc/sphinx/source/core/overview.rst
View file @ 9e34172a
.. core/overview.rst:
.. _ngraph_core:
Basic Concepts
==============
......
doc/sphinx/source/core/passes/passes.rst
View file @ 9e34172a
......@@ -95,7 +95,7 @@ group before finally concatenating the result back together.
.. _figure-mobilenet-gc:
.. figure:: ../../graphics/mobilenet-group-conv.png
.. figure:: ../../graphics/mobilenet-group-conv.svg
:width: 700px
:alt: MobileNet example
......@@ -109,4 +109,4 @@ several ways:
* Reduces sheer node count,
* Provides mappability to MKL-DNN, which has an accelerated group convolution implementation, and
* Eliminates unnecessary temporary nodes.
\ No newline at end of file
* Eliminates unnecessary temporary nodes.
doc/sphinx/source/frameworks/overview.rst
View file @ 9e34172a
.. frameworks/overview.rst
.. _framework_support:
Basic concepts
==============
......
doc/sphinx/source/graphics/mobilenet-group-conv.svg 0 → 100644
View file @ 9e34172a
This source diff could not be displayed because it is too large. You can view the blob instead.
doc/sphinx/source/inspection/index.rst
View file @ 9e34172a
.. inspection/index:
.. _inspection:
Visualization Tools
###################
......
doc/sphinx/source/sitemap.rst 0 → 100644
View file @ 9e34172a
:orphan:
Sitemap
#######
* :ref:`Getting Started <introduction>`
.. toctree::
:maxdepth: 1
introduction
tutorials/index.rst
* :ref:`Framework Support <framework_support>`
.. toctree::
:maxdepth: 1
frameworks/overview.rst
frameworks/tensorflow_connect.rst
frameworks/onnx_integ.rst
frameworks/paddle_integ.rst
frameworks/other/index.rst
* :ref:`nGraph Core <ngraph_core>`
.. toctree::
:maxdepth: 1
core/overview.rst
buildlb.rst
core/constructing-graphs/index.rst
core/passes/passes.rst
core/fusion/index.rst
nGraph Core Ops <ops/index.rst>
provenance/index.rst
core/quantization.rst
dynamic/index.rst
* :ref:`Backend Support <backend_support>`
.. toctree::
:maxdepth: 1
Basic Concepts <backends/index.rst>
backends/plaidml-ng-api/index.rst
Integrating Other Backends <backends/cpp-api.rst>
* :ref:`Training <training>`
.. toctree::
:maxdepth: 1
training/index.rst
training/qat.rst
* :ref:`Validated Workloads <validated>`
.. toctree::
:maxdepth: 1
frameworks/validated/list.rst
* :ref:`Debugging Graphs <inspection>`
.. toctree::
:maxdepth: 1
inspection/index.rst
* :ref:`Contribution <contribution_guide>`
.. toctree::
:maxdepth: 1
project/contribution-guide.rst
glossary.rst
doc/sphinx/source/training/index.rst
View file @ 9e34172a
.. training/index.rst:
.. _training:
Distributed Training
####################
......
doc/sphinx/source/training/overview.rst
View file @ 9e34172a
.. training/overview.rst:
.. _overview:
Basic Concepts
==============
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment