[WIP] New Website: New Docs [1/3] (#15884)

* Adding new website files

Co-authored-by: Thomas Delteil <[email protected]>
Co-authored-by: Aaron Markham <[email protected]>

* add license header

* fixing links and url + css

* fixing tutorials

* exclude python_docs folder when building prod site

This allows things to coexist until a following PR deletes this file.

* license header fixes

* exclude static site from license header check

* exclude static site and sphinx theme

* exclude static_site and cpp_docs from sphinx

* add licenses and excludes

docs/conf.py

@@ -107,7 +107,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['3rdparty', 'api/python/model.md', 'build_version_doc', 'README.md', 'tutorial_utils', 'virtualenv']
+exclude_patterns = ['3rdparty', 'api/python/model.md', 'build_version_doc', 'cpp_docs', 'python_docs', 'README.md', 'static_site', 'tutorial_utils', 'virtualenv']
 
 
 # The reST default role (used for this markup: `text`) to use for all documents.

docs/cpp_docs/Makefile

@@ -0,0 +1,26 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+all: html
+
+html:
+	mkdir -p build/html
+	doxygen Doxyfile
+
+
+clean:
+	rm -rf build

docs/python_docs/README.md

@@ -0,0 +1,24 @@
+<!--- Licensed to the Apache Software Foundation (ASF) under one -->
+<!--- or more contributor license agreements.  See the NOTICE file -->
+<!--- distributed with this work for additional information -->
+<!--- regarding copyright ownership.  The ASF licenses this file -->
+<!--- to you under the Apache License, Version 2.0 (the -->
+<!--- "License"); you may not use this file except in compliance -->
+<!--- with the License.  You may obtain a copy of the License at -->
+
+<!---   http://www.apache.org/licenses/LICENSE-2.0 -->
+
+<!--- Unless required by applicable law or agreed to in writing, -->
+<!--- software distributed under the License is distributed on an -->
+<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!--- KIND, either express or implied.  See the License for the -->
+<!--- specific language governing permissions and limitations -->
+<!--- under the License. -->
+
+# README
+
+Preview at https://mxnet-beta.staged.apache.org/
+
+## [Building the Docs and Website](https://cwiki.apache.org/confluence/display/MXNET/Building+the+New+Website)
+
+## [Technical details for the building the Python microsite](python/README.md)

docs/python_docs/_static/google_analytics.js

@@ -0,0 +1,26 @@
+ /*!
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', 'UA-96378503-11', 'auto');
+  ga('send', 'pageview');

docs/python_docs/_static/mxnet.css

@@ -0,0 +1,199 @@
+/* THOMAS EDITS */
+
+.logo {
+    width: 120px !important;
+    padding: 21px !important;
+    margin: auto !important;    
+}
+
+@media only screen and (min-width: 1025px) {
+    .mdl-navigation.breadcrumb {
+        margin-left: 100px !important;
+    }
+    .mdl-layout__drawer {
+        width: 300px !important;
+    }
+}
+
+.mdl-layout__container {
+    visibility: hidden;
+}
+
+.document .page-content {
+    padding: 0 10% !important;
+}
+
+.mdl-layout__header--waterfall.is-casting-shadow {
+    box-shadow: none !important;
+}
+
+.mdl-layout__header.is-compact {
+    max-height: inherit !important;
+}
+
+.mx-card {
+    box-shadow: none;
+    transition: box-shadow 0.3s linear;
+}
+
+.mx-card.head-card {
+    width: 100% !important;
+}
+
+.mx-card-title {
+    font-weight: 300 !important
+}
+
+.mx-card:hover .mx-card-title {
+    color: orangered !important;
+}
+
+.mdl-card:hover {
+    box-shadow: inset 0 -2px 0 0 #048ccc !important;
+}
+
+.mdl-layout__header-row {
+    height: 84px !important;
+}
+
+.mdl-shadow--2dp {
+    box-shadow: none !important;
+}
+
+
+div.mdl-layout__header-row.header-links {
+    display: none !important;
+    visibility: none !important;
+    background-color: #fafafa !important;
+}
+
+.header_links {
+    display: none !important;
+    visibility: none !important;
+    background-color: #fafafa !important;
+}
+
+
+.mdl-layout__header {
+    background-color: rgb(4,140,204);
+}
+.mdl-layout-title {
+    background-color: rgb(4,140,204);
+}
+
+
+.mdl-layout__drawer {
+    box-shadow: none !important;
+    border: none !important;
+}
+
+.pagenation {
+    visibility: hidden !important;
+}
+
+footer.mdl-mini-footer {
+    width: 100%;
+    padding-left: 150px;
+    background-color: #424242 !important;
+}
+
+
+/* END OF THOMAS EDITS */
+
+
+body {
+    font-family: 'Roboto', sans-serif;
+}
+
+p {
+    font-size: 16px;
+    /*     font-weight: 400; */
+    line-height: 1.5em;
+    margin: 16px 0;
+}
+
+.sidebar {
+    float: right;
+    display: block;
+    width: 30%;
+    padding: 0 20px;
+    margin: 0 20px;
+    background-color: #eee;
+    border-radius: 8px;
+
+}
+
+@media (max-width: 500px) {
+    .sidebar {
+        float: none;
+        width: 100%;
+        padding: 0 10px;
+        margin: 0 10px;
+        width: 80%;
+    }
+}
+
+.sidebar .sidebar-title {
+    text-align: center;
+    display: block;
+    margin-bottom: 0px;
+    display: none;
+}
+
+.align-center {
+    text-align: center;
+    display: block;
+    /* float: right; */
+    margin: auto;
+}
+
+/* API section */
+
+.mx-api .section .hidden-section {
+    display: none;
+}
+
+.mx-api h3.mdl-color-text--primary {
+    /* display: none; */
+
+    /* border-top-style: solid; */
+    /* border-color: #ccc; */
+    /* border-top-width: 1px; */
+    padding: 1em 0 0 0;
+    margin: 2em 0 0 0;
+    height: 0;
+}
+
+/* .section .viewcode-link { */
+/*     padding-left: 2em; */
+/*     font-size: 80%; */
+/* } */
+
+.section .class dt {
+    padding-bottom: 1em;
+}
+
+.install {
+    max-width: 800px;
+}
+.install .title {
+    display: inline-block;
+    min-width: 100px;
+    text-transform: uppercase;
+    font-size: 90%;
+    color: #555;
+}
+
+.install .option {
+    margin: 5px;
+}
+
+@media (max-width: 650px) {
+    .install .option, .install .title {
+        width: 90%;
+    }
+}
+
+.install .title {
+    margin-top: 1em;
+}

docs/python_docs/environment.yml

@@ -0,0 +1,38 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: mxnet-docs
+channels:
+- conda-forge
+dependencies:
+- conda>=4.6.13
+- pip
+- python
+- jupyter
+- sphinx
+- matplotlib
+- notebook
+- pip:
+  # using nbconvert master until v5.5 comes out
+  - git+https://github.com/jupyter/nbconvert@master
+  - nbsphinx>=0.4.2
+  - recommonmark
+  - notedown
+  - pypandoc
+  - breathe
+  - mock
+  - awscli

docs/python_docs/python/.gitignore

@@ -0,0 +1,20 @@
+_build/
+build/**/*.rst
+build/**/*.ipynb
+build/**/*.md
+__pycache__
+/build.sh
+_autogen
+*.ndarray
+*.pickle
+/365px-Golden_Retriever_medium-to-light-coat.jpg
+/net.params
+/synset.txt
+*.pt
+**/raw/*-ubyte
+dogcat
+*.tar.gz
+*.jpg
+*checkpoint.md
+*.ipynb_checkpoints*
+*.json