Commit d309e96f authored by L.S. Cook's avatar L.S. Cook Committed by Robert Kimball

Update doc build v and fix doc on captioning (#1568)

* Update doc build v and fix doc on captioning

* Clarify to build the library

* update link on README
parent 9ea38d22
...@@ -70,7 +70,7 @@ to improve the Library: ...@@ -70,7 +70,7 @@ to improve the Library:
modifications are necessary, may provide feedback to guide you. When modifications are necessary, may provide feedback to guide you. When
accepted, your pull request will be merged to the repository. accepted, your pull request will be merged to the repository.
[install]: http://ngraph.nervanasys.com/docs/latest/install.html [install]: http://ngraph.nervanasys.com/docs/latest/buildlb.html
[framework integration guides]: http://ngraph.nervanasys.com/docs/latest/framework-integration-guides.html [framework integration guides]: http://ngraph.nervanasys.com/docs/latest/framework-integration-guides.html
[Github issues]: https://github.com/NervanaSystems/ngraph/issues [Github issues]: https://github.com/NervanaSystems/ngraph/issues
[contrib guide]: http://ngraph.nervanasys.com/docs/latest/project/code-contributor-README.html [contrib guide]: http://ngraph.nervanasys.com/docs/latest/project/code-contributor-README.html
......
...@@ -79,17 +79,6 @@ ...@@ -79,17 +79,6 @@
{# swagger-ui loading for API doc display #} {# swagger-ui loading for API doc display #}
<link rel="stylesheet" href="{{ pathto('_static/css/swagger.css', 1) }}" type="text/css" /> <link rel="stylesheet" href="{{ pathto('_static/css/swagger.css', 1) }}" type="text/css" />
<script src="{{ pathto('_static/js/jquery-1.8.0.min.js', 1) }}"></script>
<script src="{{ pathto('_static/js/jquery.slideto.min.js', 1) }}"></script>
<script src="{{ pathto('_static/js/jquery.wiggle.min.js', 1) }}"></script>
<script src="{{ pathto('_static/js/jquery.ba-bbq.min.js', 1) }}"></script>
<script src="{{ pathto('_static/js/handlebars-2.0.0.js', 1) }}"></script>
<script src="{{ pathto('_static/js/underscore-min.js', 1) }}"></script>
<script src="{{ pathto('_static/js/backbone-min.js', 1) }}"></script>
<script src="{{ pathto('_static/js/swagger-ui.js', 1) }}"></script>
<script src="{{ pathto('_static/js/highlight.7.3.pack.js', 1) }}"></script>
<script src="{{ pathto('_static/js/marked.js', 1) }}"></script>
<script src="{{ pathto('_static/js/swagger-oauth.js', 1) }}"></script>
</head> </head>
......
.. install.rst: .. buildlb.rst:
######## ##################
Install Build the Library
######## ##################
* :ref:`ubuntu` * :ref:`ubuntu`
* :ref:`centos` * :ref:`centos`
...@@ -193,14 +193,14 @@ Test ...@@ -193,14 +193,14 @@ Test
==== ====
The |InG| library code base uses GoogleTest's\* `googletest framework`_ The |InG| library code base uses GoogleTest's\* `googletest framework`_
for unit tests. The ``cmake`` command from the :doc:`install` guide for unit tests. The ``cmake`` command from the :doc:`buildlb` guide
automatically downloaded a copy of the needed ``gtest`` files when automatically downloaded a copy of the needed ``gtest`` files when
it configured the build directory. it configured the build directory.
To perform unit tests on the install: To perform unit tests on the install:
#. Create and configure the build directory as described in our #. Create and configure the build directory as described in our
:doc:`install` guide. :doc:`buildlb` guide.
#. Enter the build directory and run ``make check``: #. Enter the build directory and run ``make check``:
......
...@@ -69,9 +69,9 @@ author = 'Intel Corporation' ...@@ -69,9 +69,9 @@ author = 'Intel Corporation'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.6' version = '0.7'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.6.0' release = '0.7.1'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
...@@ -196,7 +196,7 @@ breathe_projects = { ...@@ -196,7 +196,7 @@ breathe_projects = {
rst_epilog = u""" rst_epilog = u"""
.. |codename| replace:: Intel nGraph .. |codename| replace:: Intel nGraph
.. |project| replace:: Intel nGraph library .. |project| replace:: Intel nGraph Library
.. |InG| replace:: Intel® nGraph .. |InG| replace:: Intel® nGraph
.. |nGl| replace:: nGraph library .. |nGl| replace:: nGraph library
.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN .. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN
......
...@@ -56,7 +56,7 @@ system that already has an ``ngraph_dist`` installed. ...@@ -56,7 +56,7 @@ system that already has an ``ngraph_dist`` installed.
.. important:: As of version |version|, these instructions presume that your .. important:: As of version |version|, these instructions presume that your
system already has the library installed to the default location, as outlined system already has the library installed to the default location, as outlined
in our :doc:`install` documentation. in our :doc:`buildlb` documentation.
#. Set the ``NGRAPH_CPP_BUILD_PATH`` and the ``LD_LIBRARY_PATH``. You can use #. Set the ``NGRAPH_CPP_BUILD_PATH`` and the ``LD_LIBRARY_PATH``. You can use
...@@ -80,7 +80,7 @@ system that already has an ``ngraph_dist`` installed. ...@@ -80,7 +80,7 @@ system that already has an ``ngraph_dist`` installed.
(neon_venv) ~/frameworks$ (neon_venv) ~/frameworks$
#. Go to the "python" subdirectory of the ``ngraph`` repo we cloned during the #. Go to the "python" subdirectory of the ``ngraph`` repo we cloned during the
previous :doc:`install`, and complete these actions: previous :doc:`buildlb`, and complete these actions:
.. code-block:: console .. code-block:: console
......
...@@ -40,7 +40,7 @@ backends. ...@@ -40,7 +40,7 @@ backends.
Other, Not yet, Ask Other, Not yet, Ask
Regardless of the framework, after the :doc:`../install`, a good place to start Regardless of the framework, after the :doc:`../buildlb`, a good place to start
usually involves making the libraries available to the framework. On Linux\* usually involves making the libraries available to the framework. On Linux\*
systems, that command tends to looks something like: systems, that command tends to looks something like:
......
...@@ -26,7 +26,7 @@ usually named ``<some_model>.onnx`` or ``<some_model>.onnx.pb``. These ...@@ -26,7 +26,7 @@ usually named ``<some_model>.onnx`` or ``<some_model>.onnx.pb``. These
or ``.onnx.pb`` formatted file, you should be able to run the inference or ``.onnx.pb`` formatted file, you should be able to run the inference
without needing to dig into anything from the "Frameworks" sections. You without needing to dig into anything from the "Frameworks" sections. You
will, however, need to have completed the steps outlined in will, however, need to have completed the steps outlined in
our :doc:`../install` guide. If you intend to build nGraph for : doc:`distributed-training`, our :doc:`../buildlb` guide. If you intend to build nGraph for : doc:`distributed-training`,
you will need to build that has already been compiled with the additional you will need to build that has already been compiled with the additional
cmake flag: ``-DNGRAPH_DISTRIBUTED_ENABLE=TRUE``. cmake flag: ``-DNGRAPH_DISTRIBUTED_ENABLE=TRUE``.
......
...@@ -121,7 +121,7 @@ resources available for the breadth of ML/DL tasks. We welcome ideas and ...@@ -121,7 +121,7 @@ resources available for the breadth of ML/DL tasks. We welcome ideas and
Further project details can be found on our :doc:`project/about` page, or see Further project details can be found on our :doc:`project/about` page, or see
our :doc:`install` guide for how to get started. our :doc:`buildlb` guide for how to get started.
.. note:: The library code is under active development as we're continually .. note:: The library code is under active development as we're continually
...@@ -139,7 +139,7 @@ Contents ...@@ -139,7 +139,7 @@ Contents
:name: tocmaster :name: tocmaster
:caption: Documentation :caption: Documentation
install.rst buildlb.rst
graph-basics.rst graph-basics.rst
howto/index.rst howto/index.rst
ops/index.rst ops/index.rst
......
...@@ -83,18 +83,18 @@ line numbers, and add a caption: ...@@ -83,18 +83,18 @@ line numbers, and add a caption:
:: ::
.. literalinclude:: ../../../../src/ngraph/descriptor/primary_tensor_view.cpp .. literalinclude:: ../../../examples/abc/abc.cpp
:language: cpp :language: cpp
:lines: 20-31 :lines: 20-31
:caption: "primary_tensor_view.cpp" :caption: "sample caption"
and the generated output will show readers of your helpful documentation and the generated output will show readers of your helpful documentation
.. literalinclude:: ../../../../src/ngraph/descriptor/primary_tensor_view.cpp .. literalinclude:: ../../../examples/abc/abc.cpp
:language: cpp :language: cpp
:lines: 20-31 :lines: 20-31
:caption: "primary_tensor_view.cpp" :caption: "sample caption for a code block"
Our documentation practices are designed around "write once, reuse" that we can Our documentation practices are designed around "write once, reuse" that we can
use to prevent code bloat. See the :doc:`code-contributor-README` for our code use to prevent code bloat. See the :doc:`code-contributor-README` for our code
......
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