From 0e3cdda160f13f8f154d2f308f569d06ce368929 Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Tue, 4 Sep 2018 11:56:14 -0700 Subject: [PATCH 1/3] adding missing python modules as tools folder for docs --- docs/api/python/index.md | 10 ++++++++++ docs/api/python/tools/index.md | 7 +++++++ docs/api/python/tools/test_utils.md | 27 +++++++++++++++++++++++++++ docs/api/python/tools/viz.md | 27 +++++++++++++++++++++++++++ 4 files changed, 71 insertions(+) create mode 100644 docs/api/python/tools/index.md create mode 100644 docs/api/python/tools/test_utils.md create mode 100644 docs/api/python/tools/viz.md diff --git a/docs/api/python/index.md b/docs/api/python/index.md index 420f4c9b72f6..ed5cc4501b77 100644 --- a/docs/api/python/index.md +++ b/docs/api/python/index.md @@ -149,6 +149,16 @@ Code examples are placed throughout the API documentation and these can be run a rtc/rtc.md ``` +## Tools + +```eval_rst +.. toctree:: + :maxdepth: 1 + + tools/test_utils.md + tools/viz.md +``` + ## Contrib Package ```eval_rst diff --git a/docs/api/python/tools/index.md b/docs/api/python/tools/index.md new file mode 100644 index 000000000000..5348d1db0d56 --- /dev/null +++ b/docs/api/python/tools/index.md @@ -0,0 +1,7 @@ +# Tools + +```eval_rst +.. toctree:: + :glob: + * +``` diff --git a/docs/api/python/tools/test_utils.md b/docs/api/python/tools/test_utils.md new file mode 100644 index 000000000000..6fa603980121 --- /dev/null +++ b/docs/api/python/tools/test_utils.md @@ -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: + + test_utils +``` + +## API Reference + + + +```eval_rst + +.. automodule:: mxnet.test_utils + :members: + +``` + + diff --git a/docs/api/python/tools/viz.md b/docs/api/python/tools/viz.md new file mode 100644 index 000000000000..785f1be9f72b --- /dev/null +++ b/docs/api/python/tools/viz.md @@ -0,0 +1,27 @@ +# Viz + +Viz is short for visualization. This module contains visualization features. + +```eval_rst + .. currentmodule:: mxnet.viz +``` + +```eval_rst +.. autosummary:: + :nosignatures: + + viz +``` + +## API Reference + + + +```eval_rst + +.. automodule:: mxnet.viz + :members: + +``` + + From bd5d2aaff778739ba1e2d3b763c6b66364fb9544 Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Tue, 4 Sep 2018 11:56:14 -0700 Subject: [PATCH 2/3] adding missing python modules as tools folder for docs --- docs/api/python/index.md | 11 +++++++++++ docs/api/python/tools/index.md | 7 +++++++ docs/api/python/tools/test_utils.md | 27 +++++++++++++++++++++++++++ docs/api/python/tools/viz.md | 27 +++++++++++++++++++++++++++ 4 files changed, 72 insertions(+) create mode 100644 docs/api/python/tools/index.md create mode 100644 docs/api/python/tools/test_utils.md create mode 100644 docs/api/python/tools/viz.md diff --git a/docs/api/python/index.md b/docs/api/python/index.md index 42c4af9e46b5..080e746ea3e9 100644 --- a/docs/api/python/index.md +++ b/docs/api/python/index.md @@ -155,6 +155,7 @@ Code examples are placed throughout the API documentation and these can be run a rtc/rtc.md ``` + ## Symbol API ```eval_rst @@ -177,3 +178,13 @@ Code examples are placed throughout the API documentation and these can be run a symbol_in_pictures/symbol_in_pictures.md ``` + +## Tools + +```eval_rst +.. toctree:: +:maxdepth: 1 + +tools/test_utils.md +tools/viz.md +``` diff --git a/docs/api/python/tools/index.md b/docs/api/python/tools/index.md new file mode 100644 index 000000000000..5348d1db0d56 --- /dev/null +++ b/docs/api/python/tools/index.md @@ -0,0 +1,7 @@ +# Tools + +```eval_rst +.. toctree:: + :glob: + * +``` diff --git a/docs/api/python/tools/test_utils.md b/docs/api/python/tools/test_utils.md new file mode 100644 index 000000000000..6fa603980121 --- /dev/null +++ b/docs/api/python/tools/test_utils.md @@ -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: + + test_utils +``` + +## API Reference + + + +```eval_rst + +.. automodule:: mxnet.test_utils + :members: + +``` + + diff --git a/docs/api/python/tools/viz.md b/docs/api/python/tools/viz.md new file mode 100644 index 000000000000..785f1be9f72b --- /dev/null +++ b/docs/api/python/tools/viz.md @@ -0,0 +1,27 @@ +# Viz + +Viz is short for visualization. This module contains visualization features. + +```eval_rst + .. currentmodule:: mxnet.viz +``` + +```eval_rst +.. autosummary:: + :nosignatures: + + viz +``` + +## API Reference + + + +```eval_rst + +.. automodule:: mxnet.viz + :members: + +``` + + From cd0f04cfb4d21060d72e3ba50599435392ad338f Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Tue, 4 Sep 2018 19:31:47 +0000 Subject: [PATCH 3/3] adjusted paths after testing build --- docs/api/python/index.md | 2 +- docs/api/python/tools/index.md | 7 ------- docs/api/python/tools/test_utils.md | 2 +- docs/api/python/tools/{viz.md => visualization.md} | 10 +++++----- 4 files changed, 7 insertions(+), 14 deletions(-) delete mode 100644 docs/api/python/tools/index.md rename docs/api/python/tools/{viz.md => visualization.md} (61%) diff --git a/docs/api/python/index.md b/docs/api/python/index.md index c69d638298c5..7be51083bc17 100644 --- a/docs/api/python/index.md +++ b/docs/api/python/index.md @@ -185,5 +185,5 @@ Code examples are placed throughout the API documentation and these can be run a :maxdepth: 1 tools/test_utils.md - tools/viz.md + tools/visualization.md ``` diff --git a/docs/api/python/tools/index.md b/docs/api/python/tools/index.md deleted file mode 100644 index 5348d1db0d56..000000000000 --- a/docs/api/python/tools/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# Tools - -```eval_rst -.. toctree:: - :glob: - * -``` diff --git a/docs/api/python/tools/test_utils.md b/docs/api/python/tools/test_utils.md index 6fa603980121..e29d9b99a844 100644 --- a/docs/api/python/tools/test_utils.md +++ b/docs/api/python/tools/test_utils.md @@ -10,7 +10,7 @@ This module has a variety of tools that help using and testing MXNet. .. autosummary:: :nosignatures: - test_utils + mxnet.test_utils ``` ## API Reference diff --git a/docs/api/python/tools/viz.md b/docs/api/python/tools/visualization.md similarity index 61% rename from docs/api/python/tools/viz.md rename to docs/api/python/tools/visualization.md index 785f1be9f72b..6faa24980dd8 100644 --- a/docs/api/python/tools/viz.md +++ b/docs/api/python/tools/visualization.md @@ -1,16 +1,16 @@ -# Viz +# Visualization -Viz is short for visualization. This module contains visualization features. +This module contains visualization features. ```eval_rst - .. currentmodule:: mxnet.viz + .. currentmodule:: mxnet.visualization ``` ```eval_rst .. autosummary:: :nosignatures: - viz + mxnet.visualization ``` ## API Reference @@ -19,7 +19,7 @@ Viz is short for visualization. This module contains visualization features. ```eval_rst -.. automodule:: mxnet.viz +.. automodule:: mxnet.visualization :members: ```