Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

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

Merged
merged 12 commits into from
Sep 6, 2019
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2,370 changes: 2,370 additions & 0 deletions docs/cpp_docs/Doxyfile

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/cpp_docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
all: html

html:
mkdir -p build/html
doxygen Doxyfile


clean:
rm -rf build
10 changes: 10 additions & 0 deletions docs/python_docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# README
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should update this...

This is an in-progress project for the MXNet documentation website.

Preview at https://beta.mxnet.io/

## [What's new](https://github.com/mli/new-docs/wiki/What's-new)

## [Roadmap](https://github.com/mli/new-docs/projects/1)

## [Contribute](python/README.md)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/python_docs/_static/google_analytics.js
Original file line number Diff line number Diff line change
@@ -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');
33 changes: 33 additions & 0 deletions docs/python_docs/_static/minima-social-icons.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/python_docs/_static/mxnet-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
199 changes: 199 additions & 0 deletions docs/python_docs/_static/mxnet.css
Original file line number Diff line number Diff line change
@@ -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;
}
Binary file added docs/python_docs/_static/mxnet_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/python_docs/environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
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
20 changes: 20 additions & 0 deletions docs/python_docs/python/.gitignore
Original file line number Diff line number Diff line change
@@ -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
40 changes: 40 additions & 0 deletions docs/python_docs/python/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
all: html

# markdown files that will not be evaluated, simply copy to build/
PURE_MARKDOWN = ./README.md
# markdown files that will be evaluated and then saved as ipynb files
IPYNB_MARKDOWN = $(shell find . -not -path "./build/*" -not -path "*.ipynb_checkpoints*" -name "*.md" | sort -h)
# RST files will be simply coped to build/
RST = $(shell find . -not -path "./build/*" -not -path "*.ipynb_checkpoints*" -name "*.rst")

OBJ = $(patsubst %.rst, build/%.rst, $(RST)) \
$(patsubst %.md, build/%.md, $(PURE_MARKDOWN)) \
$(patsubst %.md, build/%.ipynb, \
$(filter-out $(PURE_MARKDOWN), $(IPYNB_MARKDOWN)))

build/%.ipynb: %.md
@mkdir -p $(@D)
python scripts/md2ipynb.py $< $@


build/%.rst: %.rst
@mkdir -p $(@D)
# python scripts/process_rst.py $< $@
cp $< $@

build/%: %
@mkdir -p $(@D)
@cp -r $< $@


html: $(OBJ)
mkdir -p build
cp Makefile_sphinx build/Makefile
sphinx-autogen build/api/*.rst build/api/*/*.rst -t build/_templates/
# make -C build linkcheck doctest html
make -C build html
sed -i.bak 's/33\,150\,243/23\,141\,201/g' build/_build/html/_static/material-design-lite-1.3.0/material.blue-deep_orange.min.css


clean:
rm -rf build
Loading