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

Data Iterators documentation is broken #12854

Closed
anirudhacharya opened this issue Oct 17, 2018 · 4 comments · Fixed by #12871
Closed

Data Iterators documentation is broken #12854

anirudhacharya opened this issue Oct 17, 2018 · 4 comments · Fixed by #12871

Comments

@anirudhacharya
Copy link
Member

anirudhacharya commented Oct 17, 2018

Many of the API references are not working - http://mxnet.incubator.apache.org/api/python/io/io.html#data-iterators
screen shot 2018-10-17 at 1 44 48 pm

@anirudhacharya
Copy link
Member Author

@mxnet-label-bot [Doc, Data-loading]

@aaronmarkham please check

@aaronmarkham
Copy link
Contributor

aaronmarkham commented Oct 17, 2018

It seems like importing in the Python module is misconfigured. Refer to #12829
and
#12318 -- seems closer to the issue found here.

@aaronmarkham
Copy link
Contributor

So Sphinx is getting confused. See this related issue: sphinx-doc/sphinx#4961
It looks like to process to fix this is to be very specific about what method is being referenced. I'm working on a solution for this page, but it looks like this is a problem throughout the docs.

@aaronmarkham
Copy link
Contributor

This is ending up being a fairly big issue. The changes since v1.3.0 have caused many of the docs to disappear or point to the wrong methods when methods have the same name.
Sphinx isn't seeing what's there. The autosummary / autodoc features would just walk through the APIs and list things out.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants