Data Iterators documentation is broken #12854

Activity

1. anirudhacharya commented on Oct 17, 2018

   

   anirudhacharya

   on Oct 17, 2018

   MemberAuthor

   More actions

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

   @aaronmarkham please check
2. marcoabreu

   added

   Data-loading

   Doc

   on Oct 17, 2018
3. aaronmarkham commented on Oct 17, 2018

   

   aaronmarkham

   on Oct 17, 2018

   Last edited by aaronmarkham

   Contributor

   More actions

   It seems like importing in the Python module is misconfigured. Refer to #12829
   and
   #12318 -- seems closer to the issue found here.
4. aaronmarkham commented on Oct 18, 2018

   

   aaronmarkham

   on Oct 18, 2018

   Contributor

   More actions

   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.
5. aaronmarkham commented on Oct 18, 2018

   

   aaronmarkham

   on Oct 18, 2018

   Contributor

   More actions

   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.
6. zhreshold

   closed this as completedin #12871on Oct 24, 2018