@lanking520 It appears that the impacted pages are not a "normal" scaladocs as 
they are generated during the "macro" stage. Refer to this comment:
https://github.com/apache/incubator-mxnet/blob/master/scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala#L27-L31
... where it states the NDArrayBaseAPI and SymbolBaseAPI are generated in this 
way.

Looking at the output you can see that the rst isn't being parsed properly. I'm 
not sure where this "macro" code is, but that's where I'd look and see if 
something is breaking the rst. The rst is then going to be parsed Sphinx during 
the docs build. The scaladocs step with Sphinx generates massive amounts of 
warnings and errors, so tracking this down will be not fun, but I'm pretty sure 
it can be troubleshooted by running the [docs 
build](https://cwiki.apache.org/confluence/display/MXNET/How+to+Build+the+Website)
 and tinkering with that macro step's output. Maybe this would be a good 
opportunity to fix some of those scaladocs errors, so troubleshooting this area 
is not like searching for a needle in a haystack.

Here are the broken pages:
* 
https://mxnet.incubator.apache.org/api/scala/docs/index.html#org.apache.mxnet.SymbolAPI$
* 
https://mxnet.incubator.apache.org/api/scala/docs/index.html#org.apache.mxnet.SymbolAPIBase
* 
https://mxnet.incubator.apache.org/api/scala/docs/index.html#org.apache.mxnet.SymbolBase
* 
https://mxnet.incubator.apache.org/api/scala/docs/index.html#org.apache.mxnet.NDArrayAPI$
* 
https://mxnet.incubator.apache.org/api/scala/docs/index.html#org.apache.mxnet.NDArrayAPIBase
* 
https://mxnet.incubator.apache.org/api/scala/docs/index.html#org.apache.mxnet.NDArrayBase


[ Full content available at: 
https://github.com/apache/incubator-mxnet/issues/12657 ]
This message was relayed via gitbox.apache.org for [email protected]

Reply via email to