Skip to content

Commit

Permalink
Tutorials index page update (apache#9535)
Browse files Browse the repository at this point in the history
* changed url references from dmlc to apache/incubator-mxnet

* added selector to tutorials page; added fixed tutorials; fixed links

* fixed a link

* changed gluon intro

* updated release version to 1.0.1 on the mainpage and re-arranged news tiles

* removed 3 tutorials from gluon category; already in symbol

* bigger button; changed category to module

* refactored the selector, removed categories, removed 13 tutorials
  • Loading branch information
aaronmarkham authored and eric-haibin-lin committed Jan 27, 2018
1 parent f1ae225 commit 6a4671b
Show file tree
Hide file tree
Showing 8 changed files with 245 additions and 74 deletions.
18 changes: 11 additions & 7 deletions docs/_static/js/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function render_left_helper(toc) {
$('.leftsidebar > .sphinxsidebarwrapper').append(lefttoc);

addToggle('.leftsidebar');

$('.leftsidebar li a').click(function () {
$('.leftsidebar li a').css('color', '#337ab7');
$(this).css('color', 'black');
Expand Down Expand Up @@ -77,18 +77,18 @@ function render_lefttoc() {
/*Render contents inside page*/
function render_righttoc() {
var url = window.location.href, indexTrailing = 'index.html';

var rightTocTitle = "Page Contents";
$("div.rightsidebar > div.sphinxsidebarwrapper > h3").children().remove();
$("div.rightsidebar > div.sphinxsidebarwrapper > h3").html(rightTocTitle);

addToggle('.rightsidebar');

$('.rightsidebar li a').click(function () {
$('.rightsidebar li a').css('color', '#337ab7');
$(this).css('color', 'black');
});

if (url.indexOf(indexTrailing) != -1 || isAPI) {
$('.rightsidebar').hide();
}
Expand Down Expand Up @@ -175,7 +175,7 @@ function keepExpand() {
break;
}
}

//Merge right toc into left toc for API pages since they are quite long
if (isAPI) {
var rootEntry = currentEntry;
Expand Down Expand Up @@ -234,6 +234,10 @@ $(document).ready(function () {
$('div.sphinxsidebar').hide();
$('.content').css('width', '100%');
}
if (url.indexOf('/tutorials/index.html') != -1) {
$('div.sphinxsidebar').hide();
$('.content').css('width', '100%');
}
if (showRightToc) {
$(window).scroll(function () {
scroll_righttoc();
Expand All @@ -251,4 +255,4 @@ $(document).ready(function () {
if ($('div.sphinxsidebar').css('visibility') == 'hidden') $('.content').css('width', '100%');
return;
}
});
});
23 changes: 11 additions & 12 deletions docs/_static/mxnet-theme/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,26 @@
</div>
</div>
</div>

<div class="section-tout">
<div class="container">
<div class="row">
<div class="col-lg-4 col-sm-12">
<h3>Apache MXNet 1.0 Released</h3>
<p>We're excited to announce the release of MXNet 1.0! Check out the release notes for latest updates.</p>
<a href="https://github.com/apache/incubator-mxnet/releases/tag/1.0.0">Learn More</a>
<h3>Apache MXNet 1.0.1 Released</h3>
<p>We're excited to announce the release of MXNet 1.0.1! Check out the release notes for latest updates.</p>
<a href="https://github.com/apache/incubator-mxnet/releases/tag/1.0.1">Learn More</a>
</div>
<div class="col-lg-4 col-sm-12">
<h3>Introducing - Gluon</h3>
<p>We’re happy to introduce a new elegant, easy to use, imperative interface for MXNet.
<h3>MXNet Model Server</h3>
<p>Apache MXNet Model Server (MMS) is a flexible and easy to use tool for serving deep learning models exported from MXNet or the Open Neural Network Exchange (ONNX).
</p>
<a href="http://gluon.mxnet.io">Learn More</a>
<a href="https://github.com/awslabs/mxnet-model-server/blob/master/README.md">Learn More</a>
</div>
<div class="col-lg-4 col-sm-12">
<h3>MXNet Joining Apache</h3>
<p>We’re excited to announce that MXNet has been accepted to the Apache Incubator.
</p>
<a href="http://incubator.apache.org/projects/mxnet.html">Learn More</a>
</div>
<h3>Introducing - Gluon</h3>
<p>We’re happy to introduce a new elegant, easy to use, imperative interface for MXNet.
</p>
<a href="http://gluon.mxnet.io">Learn More</a>
</div>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/mxnet-theme/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@

<link rel="icon" type="image/png" href="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-icon.png">
</head>
<body role="document" background="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-background.png">
<body role="document" background="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-background-compressed.jpeg">
<div class='content-block'>
{%- include "navbar.html" %}

Expand Down
8 changes: 4 additions & 4 deletions docs/_static/mxnet-theme/navbar.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ <h1 id="logo-wrap">
</h1>
<nav id="main-nav" class='nav-bar'>
<a class="main-nav-link" href="{{url_root}}install/index.html">Install</a>
<a class="main-nav-link" href="{{url_root}}tutorials/index.html">Tutorials</a>

<span id="dropdown-menu-position-anchor">
<a href="#" class="main-nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="true">Gluon <span class="caret"></span></a>
Expand All @@ -16,7 +15,7 @@ <h1 id="logo-wrap">
</ul>
</span>

<span id="dropdown-menu-position-anchor">
<span id="dropdown-menu-position-anchor">
<a href="#" class="main-nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="true">API <span class="caret"></span></a>
<ul id="package-dropdown-menu" class="dropdown-menu navbar-menu">
<li><a class="main-nav-link" href="{{url_root}}api/python/index.html">Python</a></li>
Expand All @@ -27,10 +26,11 @@ <h1 id="logo-wrap">
<li><a class="main-nav-link" href="{{url_root}}api/perl/index.html">Perl</a></li>
</ul>
</span>

<span id="dropdown-menu-position-anchor-docs">
<a href="#" class="main-nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="true">Docs <span class="caret"></span></a>
<ul id="package-dropdown-menu-docs" class="dropdown-menu navbar-menu">
<li><a class="main-nav-link" href="{{url_root}}tutorials/index.html">Tutorials</a>
<li><a class="main-nav-link" href="{{url_root}}faq/index.html">FAQ</a></li>
<li><a class="main-nav-link" href="{{url_root}}architecture/index.html">Architecture</a></li>
<li><a class="main-nav-link" href="https://github.com/apache/incubator-mxnet/tree/master/example">Examples</a></li>
Expand All @@ -47,9 +47,9 @@ <h1 id="logo-wrap">
<li><a class="main-nav-link" href="{{url_root}}community/index.html">Community</a></li>
<li><a class="main-nav-link" href="{{url_root}}community/contribute.html">Contribute</a></li>
<li><a class="main-nav-link" href="{{url_root}}community/powered_by.html">Powered By</a></li>
<li><a class="main-nav-link" href="http://discuss.mxnet.io">Discuss</a></li>
</ul>
</span>
<a class="main-nav-link" href="http://discuss.mxnet.io">Discuss</a>
</nav>
<script> function getRootPath(){ return "{{url_root}}" } </script>
<div class="burgerIcon dropdown">
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/mxnet.css
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ li.dropdown-submenu ul.dropdown-menu a {
}

.section-tout .container {
height: 200px;
height: 220px;
}

.section-tout .row {
Expand Down
2 changes: 2 additions & 0 deletions docs/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ and full working examples, visit the [tutorials section](../tutorials/index.md).

* [How do I create new operators in MXNet?](http://mxnet.io/faq/new_op.html)

* [How do I contribute an example or tutorial?](https://github.com/apache/incubator-mxnet/tree/master/example#contributing)

* [How do I set MXNet's environmental variables?](http://mxnet.io/faq/env_var.html)

## Questions about Using MXNet
Expand Down
Loading

0 comments on commit 6a4671b

Please sign in to comment.