Remove deepnumpy reference and move Numpy tutorials to top level (apa…

…che#18798) * move np tutorials to top level * replace deepnumpy reference to np * add info in card * remove useless entry * replace NDArray API card with np.ndarray * python site refactor * remove duplicated drawer and refactor layout * extend document width to 100% for xl devices
zheyuye · Jul 29, 2020 · 915f6b4 · 915f6b4
1 parent e9829e7
commit 915f6b4
Show file tree

Hide file tree

Showing 34 changed files with 38 additions and 38 deletions.
diff --git a/docs/python_docs/_static/mxnet.css b/docs/python_docs/_static/mxnet.css
@@ -19,10 +19,6 @@
     visibility: hidden;
 }
 
-.document .page-content {
-    padding: 0 10% !important;
-}
-
 .mdl-layout__header--waterfall.is-casting-shadow {
     box-shadow: none !important;
 }

diff --git a/docs/python_docs/python/tutorials/getting-started/crash-course/1-ndarray.md b/docs/python_docs/python/tutorials/getting-started/crash-course/1-ndarray.md
@@ -17,7 +17,7 @@
 
 # Step 1: Manipulate data with NP on MXNet
 
-This getting started exercise introduces the `np` package, which is similar to Numpy. For more information, please see [Differences between NP on MXNet and NumPy](/api/python/docs/tutorials/getting-started/deepnumpy/deepnumpy-vs-numpy.html).
+This getting started exercise introduces the `np` package, which is similar to Numpy. For more information, please see [Differences between NP on MXNet and NumPy](/api/python/docs/tutorials/getting-started/np/np-vs-numpy.html).
 
 ## Import packages and create an array
 

diff --git a/docs/python_docs/python/tutorials/getting-started/crash-course/6-use_gpus.md b/docs/python_docs/python/tutorials/getting-started/crash-course/6-use_gpus.md
@@ -148,4 +148,4 @@ for epoch in range(10):
 ## Next steps
 
 Now you have completed training and predicting with a neural network by using NP on MXNet and
-Gluon. You can check the guides to these two front ends: [What is NP on MXNet](../deepnumpy/index.html) and [gluon](../gluon_from_experiment_to_deployment.md).
+Gluon. You can check the guides to these two front ends: [What is NP on MXNet](../np/index.html) and [gluon](../gluon_from_experiment_to_deployment.md).
diff --git a/docs/python_docs/python/tutorials/getting-started/index.rst b/docs/python_docs/python/tutorials/getting-started/index.rst
@@ -30,7 +30,7 @@ The following tutorials teach how to use MXNet.
 
    .. card::
       :title: What is NP on MXNet
-      :link: deepnumpy/index.html
+      :link: np/index.html
 
       What is NP on MXNet
 
@@ -63,7 +63,7 @@ The following tutorials teach how to use MXNet.
    :maxdepth: 2
 
    crash-course/index
-   deepnumpy/index
+   np/index
    to-mxnet/index
    gluon_from_experiment_to_deployment
    logistic_regression_explained.md

diff --git a/.../getting-started/deepnumpy/cheat-sheet.md → ...torials/getting-started/np/cheat-sheet.md b/.../getting-started/deepnumpy/cheat-sheet.md → ...torials/getting-started/np/cheat-sheet.md
diff --git a/...rials/getting-started/deepnumpy/index.rst → ...on/tutorials/getting-started/np/index.rst b/...rials/getting-started/deepnumpy/index.rst → ...on/tutorials/getting-started/np/index.rst
@@ -29,4 +29,4 @@ If this is your first time using NP on MXNet, we recommend that you review the f
    :maxdepth: 1
 
    cheat-sheet
-   deepnumpy-vs-numpy
+   np-vs-numpy
diff --git a/...g-started/deepnumpy/deepnumpy-vs-numpy.md → ...torials/getting-started/np/np-vs-numpy.md b/...g-started/deepnumpy/deepnumpy-vs-numpy.md → ...torials/getting-started/np/np-vs-numpy.md
diff --git a/docs/python_docs/python/tutorials/index.rst b/docs/python_docs/python/tutorials/index.rst
@@ -48,11 +48,10 @@ Packages & Modules
       MXNet's imperative interface for Python. If you're new to MXNet, start here!
 
    .. card::
-      :title: NDArray API
-      :link: packages/ndarray/index.html
+      :title: np.ndarray API
+      :link: packages/np/index.html
 
-      How to use the NDArray API to manipulate data.
-      A useful set of tutorials for beginners.
+      This section contains the `mxnet.np` API reference documentation.
 
    .. card::
       :title: Symbol API

diff --git a/docs/python_docs/python/tutorials/packages/index.rst b/docs/python_docs/python/tutorials/packages/index.rst
@@ -91,6 +91,12 @@ Shared APIs
 
       How to use the optimizers.
 
+   .. card::
+      :title: NP on MXNet reference
+      :link: np/index.html
+
+      This section contains the mxnet.np API reference documentation.
+
 .. toctree::
    :hidden:
    :glob:

diff --git a/docs/python_docs/python/tutorials/packages/ndarray/index.rst b/docs/python_docs/python/tutorials/packages/ndarray/index.rst
@@ -45,10 +45,6 @@ NDArray
 
       For Sparse NDArray tutorials
 
-   .. card::
-      :title: NP on MXNet reference
-      :link: deepnumpy/index.html
-
       This section contains the mxnet.np API reference documentation
 
 .. toctree::
@@ -57,4 +53,3 @@ NDArray
 
    *
    sparse/index
-   deepnumpy/index
diff --git a/...ges/ndarray/deepnumpy/arrays.indexing.rst → ...tutorials/packages/np/arrays.indexing.rst b/...ges/ndarray/deepnumpy/arrays.indexing.rst → ...tutorials/packages/np/arrays.indexing.rst
diff --git a/...ages/ndarray/deepnumpy/arrays.ndarray.rst → .../tutorials/packages/np/arrays.ndarray.rst b/...ages/ndarray/deepnumpy/arrays.ndarray.rst → .../tutorials/packages/np/arrays.ndarray.rst
diff --git a/...als/packages/ndarray/deepnumpy/arrays.rst → ...s/python/tutorials/packages/np/arrays.rst b/...als/packages/ndarray/deepnumpy/arrays.rst → ...s/python/tutorials/packages/np/arrays.rst
diff --git a/...ials/packages/ndarray/deepnumpy/index.rst → ...cs/python/tutorials/packages/np/index.rst b/...ials/packages/ndarray/deepnumpy/index.rst → ...cs/python/tutorials/packages/np/index.rst
diff --git a/...orials/packages/ndarray/deepnumpy/npx.rst → ...docs/python/tutorials/packages/np/npx.rst b/...orials/packages/ndarray/deepnumpy/npx.rst → ...docs/python/tutorials/packages/np/npx.rst
diff --git a/...ckages/ndarray/deepnumpy/random/index.rst → ...on/tutorials/packages/np/random/index.rst b/...ckages/ndarray/deepnumpy/random/index.rst → ...on/tutorials/packages/np/random/index.rst
diff --git a/...ray/deepnumpy/routines.array-creation.rst → ...s/packages/np/routines.array-creation.rst b/...ray/deepnumpy/routines.array-creation.rst → ...s/packages/np/routines.array-creation.rst
diff --git a/...deepnumpy/routines.array-manipulation.rst → ...ckages/np/routines.array-manipulation.rst b/...deepnumpy/routines.array-manipulation.rst → ...ckages/np/routines.array-manipulation.rst
diff --git a/...ackages/ndarray/deepnumpy/routines.io.rst → ...hon/tutorials/packages/np/routines.io.rst b/...ackages/ndarray/deepnumpy/routines.io.rst → ...hon/tutorials/packages/np/routines.io.rst
diff --git a/...ges/ndarray/deepnumpy/routines.linalg.rst → ...tutorials/packages/np/routines.linalg.rst b/...ges/ndarray/deepnumpy/routines.linalg.rst → ...tutorials/packages/np/routines.linalg.rst
diff --git a/...kages/ndarray/deepnumpy/routines.math.rst → ...n/tutorials/packages/np/routines.math.rst b/...kages/ndarray/deepnumpy/routines.math.rst → ...n/tutorials/packages/np/routines.math.rst
diff --git a/...s/packages/ndarray/deepnumpy/routines.rst → ...python/tutorials/packages/np/routines.rst b/...s/packages/ndarray/deepnumpy/routines.rst → ...python/tutorials/packages/np/routines.rst
diff --git a/...kages/ndarray/deepnumpy/routines.sort.rst → ...n/tutorials/packages/np/routines.sort.rst b/...kages/ndarray/deepnumpy/routines.sort.rst → ...n/tutorials/packages/np/routines.sort.rst
diff --git a/...ndarray/deepnumpy/routines.statistics.rst → ...rials/packages/np/routines.statistics.rst b/...ndarray/deepnumpy/routines.statistics.rst → ...rials/packages/np/routines.statistics.rst
diff --git a/docs/python_docs/themes/mx-theme/mxtheme/layout.html b/docs/python_docs/themes/mx-theme/mxtheme/layout.html
@@ -67,10 +67,12 @@
     '_static/feedback.css',
 ] %}
 
-    {%- block header %}
-        <script type="text/javascript" src="{{ pathto('_static/sphinx_materialdesign_theme.js', 1) }} "></script>
-        <script type="text/javascript" src="{{ pathto('_static/feedback.js', 1) }}"></script>
-    {% endblock %}
+{% set script_files = script_files + [
+    '_static/sphinx_materialdesign_theme.js'
+  ]
+%}
+
+{%- block header %}{% endblock %}
 {%- block relbar1 %}{% endblock %}
 {%- block relbar2 %}{% include "relations.html" %}{% endblock %}
 {%- block sidebar2 %}{% endblock %}

diff --git a/docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css b/docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css
diff --git a/docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css.map b/docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.css.map
diff --git a/docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js b/docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js
diff --git a/docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js.map b/docs/python_docs/themes/mx-theme/mxtheme/static/sphinx_materialdesign_theme.js.map
diff --git a/docs/python_docs/_static/feedback.js → ...n_docs/themes/mx-theme/src/js/feedback.js b/docs/python_docs/_static/feedback.js → ...n_docs/themes/mx-theme/src/js/feedback.js
diff --git a/docs/python_docs/themes/mx-theme/src/js/sphinx_materialdesign_theme.js b/docs/python_docs/themes/mx-theme/src/js/sphinx_materialdesign_theme.js
@@ -1,8 +1,8 @@
 import "../scss/sphinx_materialdesign_theme.scss";
+import "./feedback";
 import "material-design-lite";
 import "babel-polyfill";
 import ScrollSpy from "./scrollspy";
-import AdjustHeight from "./adjust-height";
 
 $(function() {
 

diff --git a/docs/python_docs/themes/mx-theme/src/scss/_root.scss b/docs/python_docs/themes/mx-theme/src/scss/_root.scss
@@ -14,6 +14,14 @@ body {
     outline: none;
  }
 
+.mdl-layout__content header.mdl-layout__drawer {
+    display: none;
+}
+
+.mdl-layout--fixed-drawer>.mdl-layout__content {
+    margin-left: 300px;    
+}
+
 h1, h2, h3, h4, h5, h6, blockquote, span.mdl-layout-title,
 a.download > code.download {
     font-family: $body_font_family;

diff --git a/docs/python_docs/themes/mx-theme/src/scss/grid/_simplegrid.scss b/docs/python_docs/themes/mx-theme/src/scss/grid/_simplegrid.scss
@@ -59,15 +59,6 @@ $breakpoint-large: 60em; // 960px
   width: 100%;
   margin-left: auto;
   margin-right: auto;
-
-  @media only screen and (min-width: $breakpoint-small) {
-    width: 80%;
-  }
-
-  @media only screen and (min-width: $breakpoint-large) {
-    width: 75%;
-    max-width: 60rem;
-  }
 }
 
 .row {

diff --git a/docs/python_docs/themes/mx-theme/src/scss/layout/_layout.scss b/docs/python_docs/themes/mx-theme/src/scss/layout/_layout.scss
@@ -4,7 +4,7 @@
  $layout: (
     document: (
         xl: (
-            width: 1400px,
+            width: 100%,
         )
     ),
     drawer-container: (
@@ -65,6 +65,7 @@
             overflow-x: auto;
             overflow-y: auto;
             width: inherit;
+            right: 0px;
             &::-webkit-scrollbar {
                 width: 6px;
             }