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

Addressed sphinx build issue #13246

Merged
merged 1 commit into from
Nov 13, 2018
Merged

Addressed sphinx build issue #13246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/_static/js/auto_module_index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,17 @@ function auto_index(module) {
var html = "<ul>";

for (var i = 0; i < targets.length; ++i) {
var id = $(targets[i]).attr('id');
// remove 'mxnet.' prefix to make menus shorter
var id_simple = id.replace(/^mxnet\./, '');
html += "<li><a class='reference internal' href='#";
html += id;
html += "'>" + id_simple + "</a></li>";
var id = $(targets[i]).attr('id');
if ( id ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

[minor] remove spaces around ( )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This seems to be a critical PR. Making this change will trigger another 2-3 hour wait before this can be merged. I will hold off this chagne for another PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

So what was the issue here? This check makes the difference between the page rendering or not?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added a short note in the PR section describing the change. Please feel free to correct my understanding if I am wrong :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are correct,
http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13246/1/api/python/ndarray/ndarray.html

page wouldn't render in the previous PR but would render here.

// remove 'mxnet.' prefix to make menus shorter
var id_simple = id.replace(/^mxnet\./, '');
html += "<li><a class='reference internal' href='#";
html += id;
html += "'>" + id_simple + "</a></li>";
}
}

html += "</ul>";
li_node.append(html);
});
}
}
7 changes: 6 additions & 1 deletion docs/api/python/ndarray/ndarray.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,9 +706,14 @@ The `ndarray` package provides several classes:
:members:
:imported-members:
:special-members:
:exclude-members: CachedOp, NDArray
:exclude-members: CachedOp, NDArray, save, load

.. automodule:: mxnet.ndarray
:noindex:
:members: save, load

.. automodule:: mxnet.random
:noindex:
:members:

```
Expand Down
1 change: 1 addition & 0 deletions docs/api/python/ndarray/random.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ In the rest of this document, we list routines provided by the `ndarray.random`

.. automodule:: mxnet.random
:members:
:noindex:
Copy link
Contributor

Choose a reason for hiding this comment

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

can we also add the return values for these APIs here #13227 ? using autodoc-process-signature perhaps? http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this will take a bit more research as to why returns and return type is being populated for some and not others. Since this PR fixes some broken pages, I'd rather not hold it up, and just try to tackle #13227 in another PR.


```

Expand Down