Skip to content

Commit

Permalink
Add Python API docs for test_utils and visualization (apache#12455)
Browse files Browse the repository at this point in the history
* adding missing python modules as tools folder for docs

* adding missing python modules as tools folder for docs

* adjusted paths after testing build
  • Loading branch information
aaronmarkham authored and anirudh2290 committed Sep 19, 2018
1 parent 520f903 commit d38670b
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/api/python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,4 +177,14 @@ Code examples are placed throughout the API documentation and these can be run a
:maxdepth: 1
symbol_in_pictures/symbol_in_pictures.md
```
```

## Tools

```eval_rst
.. toctree::
:maxdepth: 1
tools/test_utils.md
tools/visualization.md
```
27 changes: 27 additions & 0 deletions docs/api/python/tools/test_utils.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Test Utilities

This module has a variety of tools that help using and testing MXNet.

```eval_rst
.. currentmodule:: mxnet.test_utils
```

```eval_rst
.. autosummary::
:nosignatures:
mxnet.test_utils
```

## API Reference

<script type="text/javascript" src='../../../_static/js/auto_module_index.js'></script>

```eval_rst
.. automodule:: mxnet.test_utils
:members:
```

<script>auto_index("api-reference");</script>
27 changes: 27 additions & 0 deletions docs/api/python/tools/visualization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Visualization

This module contains visualization features.

```eval_rst
.. currentmodule:: mxnet.visualization
```

```eval_rst
.. autosummary::
:nosignatures:
mxnet.visualization
```

## API Reference

<script type="text/javascript" src='../../../_static/js/auto_module_index.js'></script>

```eval_rst
.. automodule:: mxnet.visualization
:members:
```

<script>auto_index("api-reference");</script>

0 comments on commit d38670b

Please sign in to comment.