Merge pull request #3291 from NervanaSystems/leona/doc_v0.24

Leona/doc v0.24

doc/sphinx/source/buildlb.rst

@@ -5,7 +5,7 @@ Build and Test
 ###############
 
 * :ref:`default_ngflags`
-* :ref:`ngraph_plaidml_backend`
+.. :ref:`ngraph_plaidml_backend`
 
 There are a few common paths to take when manually building the |project| 
 from source code. Today nGraph supports various developers working on all 
@@ -161,17 +161,17 @@ The process documented here will work on CentOS 7.4.
       $ make && sudo make install 
 
 
-.. _ngraph_plaidml_backend:
+.. .. _ngraph_plaidml_backend:  hide this until announcement is official
 
-Building nGraph-PlaidML from source
-===================================
+.. Building nGraph-PlaidML from source
+.. ===================================
 
-The following instructions will create the ``~/ngraph_plaidml_dist`` 
-locally:
+.. The following instructions will create the ``~/ngraph_plaidml_dist`` 
+.. locally:
 
-#. Ensure you have installed the :ref:`prerequisites` for your OS.
+.. #. Ensure you have installed the :ref:`prerequisites` for your OS.
 
-#. Install the prerequisites for the backend. Our hybrid ``NGRAPH_PLAIDML``
+.. #. Install the prerequisites for the backend. Our hybrid ``NGRAPH_PLAIDML``
    backend works best with Python3 versions. We recommend that you use a 
    virtual environment, due to some of the difficulties that users have 
    seen when trying to install outside of a venv.
@@ -182,20 +182,20 @@ locally:
       $ pip install plaidml 
       $ plaidml-setup
 
-#. Clone the source code, create and enter your build directory:
+.. #. Clone the source code, create and enter your build directory:
 
    .. code-block:: console
 
       $ git clone https://github.com/NervanaSystems/ngraph.git
       $ cd ngraph && mkdir build && cd build
 
-#. Prepare the CMake files as follows: 
+.. #. Prepare the CMake files as follows: 
 
    .. code-block:: console
 
       $ cmake .. -DCMAKE_INSTALL_PREFIX=~/ngraph_plaidml_dist -DNGRAPH_CPU_ENABLE=OFF -DNGRAPH_PLAIDML_ENABLE=ON 
 
-#. Run :command:`make` and ``make install``. Note that if you are building 
+.. #. Run :command:`make` and ``make install``. Note that if you are building 
    outside a local or user path, you may need to run ``make install`` as the 
    root user.
 
@@ -210,8 +210,8 @@ locally:
    tests can be run when PlaidML devices are available at the machine 
    level.
 
-For more about working with the PlaidML backend from nGraph, see our 
-API documentation :doc:`backends/plaidml-ng-api/index`. 
+.. For more about working with the PlaidML backend from nGraph, see our 
+.. API documentation :doc:`backends/plaidml-ng-api/index`. 
 
 
 macOS\* development

doc/sphinx/source/project/introduction.rst

@@ -62,14 +62,14 @@ more detail and describe how nGraph addresses them.
 Problem 1: Kernel libraries do not support graph-level optimizations
 --------------------------------------------------------------------
 
-The example diagrams below shows how a deep learning framework, when integrated
+The example diagrams below show how a deep learning framework, when integrated
 with a kernel library, can optimally run each operation in a computational
 graph, but the choice of operations in the graph may not be optimal.
 
 .. _figure-A:
 
 .. figure:: ../graphics/kernel-problem-1.png
-   :width: 555px
+   :width: 100%
    :alt:
 
 
@@ -95,7 +95,7 @@ diagram.
 .. _figure-B:
 
 .. figure:: ../graphics/kernel-problem-2.png
-   :width: 555px
+   :width: 100%
    :alt:
 
 Each framework must be manually integrated with each hardware-specific kernel
@@ -130,7 +130,7 @@ work for what will ultimately be a fragile setup that is costly to maintain.
 .. _figure-C:
 
 .. figure:: ../graphics/kernel-problem-3.png
-   :width: 555px
+   :width: 100%
    :alt:
 
 

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

@@ -16,14 +16,19 @@ We are pleased to announce the release of version |version|-doc.
 
 Core updates for |version|
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-+ Better PlaidML support
 
++ More ONNX ops
++ Elementwise divide defaults to Python semantics
++ GenerateMask seed optional
++ Graph visualization improvements
++ Preserve control dependencies in more places
++ GetOutputElement has single input
 
-Latest doc updates
-~~~~~~~~~~~~~~~~~~
 
-+ Add instructions how to build ``NGRAPH_PLAIDML`` backend.
+.. Latest doc updates
+.. ~~~~~~~~~~~~~~~~~~
 
+.. + Add instructions how to build ``NGRAPH_PLAIDML`` backend.
 
 
 .. important:: Pre-releases (``-rc-0.*``) have newer features, and are less stable.  
@@ -35,7 +40,6 @@ Changelog on Previous Releases
 0.23
 ----
 
-+ PlaidML support
 + More ONNX ops
 + Elementwise divide defaults to Python semantics
 + GenerateMask seed optional

doc/sphinx/source/sitemap.rst

 :orphan:
 
-.. toctree::
-   :caption: Sitemap
-   :maxdepth: 1 
-   
-   frameworks/index
-   python_api/index
-   inspection/index
-   core/overview
-   backends/index
-   project/index
+  .. toctree::
+     :includehidden:
+
+     frameworks/index
+     project/index
+     python_api/index
+     inspection/index
+     core/overview
+     backends/index
+     project/extras/index