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

Commit

Permalink
Update Java web docs based on feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
Ayres committed Nov 21, 2018
1 parent e82d464 commit 8a790fd
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/_static/js/sidebar.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*Preprocess*/
var LANG = ['python', 'c++', 'clojure', 'julia', 'perl', 'r', 'scala'];
var LANG = ['python', 'c++', 'clojure', 'julia', 'perl', 'r', 'scala', 'java'];
var TITLE_WITH_LANG = ['/get_started/', '/tutorials/', '/faq/', '/architecture/', '/community/'];
for(var i = 0; i < LANG.length; ++i) {
TITLE_WITH_LANG.push('/api/' + LANG[i] + '/');
Expand Down
3 changes: 3 additions & 0 deletions docs/_static/mxnet-theme/navbar.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ <h1 id="logo-wrap">
<li><a class="main-nav-link" href="{{url_root}}api/perl/index.html">Perl</a></li>
<li><a class="main-nav-link" href="{{url_root}}api/r/index.html">R</a></li>
<li><a class="main-nav-link" href="{{url_root}}api/scala/index.html">Scala</a></li>
<li><a class="main-nav-link" href="{{url_root}}api/java/index.html">Java</a></li>

</ul>
</span>

Expand Down Expand Up @@ -80,6 +82,7 @@ <h1 id="logo-wrap">
<li><a class="main-nav-link" href="{{url_root}}api/perl/index.html">Perl</a></li>
<li><a class="main-nav-link" href="{{url_root}}api/r/index.html">R</a></li>
<li><a class="main-nav-link" href="{{url_root}}api/scala/index.html">Scala</a></li>
<li><a class="main-nav-link" href="{{url_root}}api/java/index.html">Java</a></li>
</ul>
</li>
<li class="dropdown-submenu">
Expand Down
7 changes: 5 additions & 2 deletions docs/api/java/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ The goal of the MXNet Java package is to provide an efficient and easy to use in
The MXNet Java package makes it easy to quickly deploy an existing model into a production level Java ecosystem.

## Tutorials
See the [tutorial page](../../tutorials/index.html) for detailed tutorials and examples using the Java Inference API.
See the [tutorial page](../../tutorials/index.html#java-tutorials) for detailed tutorials and examples using the Java Inference API.

## Java Inference API Reference
The [Java Infer API javadocs](../../docs/index.html#org.apache.mxnet.infer.package) provides detailed API information.
The [Java Infer API javadocs](../../docs/index.html#org.apache.mxnet.infer.package) provides detailed API information.

## Installation
* [MXNet Java Inference API setup instructions](../../install/java_setup.md)
6 changes: 3 additions & 3 deletions docs/install/java_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ https://mvnrepository.com/artifact/org.apache.mxnet
</dependency>
```

**NOTE:** You may specify the version you wish to use by adding the version number to the `dependency` block. For example, to use v1.2.0 you would add `<version>1.2.0</version>`. Otherwise Maven will use the latest version available.
**NOTE:** You may specify the version you wish to use by adding the version number to the `dependency` block. For example, to use v1.3.1 you would add `<version>1.3.1</version>`. Otherwise Maven will use the latest version available.

<hr>

## Source

The previously mentioned setup with Maven is recommended. Otherwise, the following instructions for macOS, Ubuntu, and Windows are provided for reference only:
The previously mentioned setup with Maven is recommended. Otherwise, the following instructions for macOS and Ubuntu are provided for reference only:

| OS | Step 1 | Step 2 |
|---|---|---|
Expand Down Expand Up @@ -108,4 +108,4 @@ To build the docs yourself, follow the [developer build docs instructions](https

* [Java API](../api/java/index.html)
* [javadocs](../api/java/docs/index.html#org.apache.mxnet.package)
* [MXNet-Java Tutorials](../tutorials/java)
* [MXNet-Java Tutorials](../../tutorials/index.html#java-tutorials)
8 changes: 8 additions & 0 deletions docs/tutorials/java/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Tutorials

```eval_rst
.. toctree::
:glob:
*
```

0 comments on commit 8a790fd

Please sign in to comment.