Re: direction for documentation across various APIs that share common doc source

Hi Aaron, You can see that the examples listed in elemwise_addDoc class in https://github.com/apache/incubator-mxnet/blob/master/python/mxnet/ndarray_doc.py#L57 are appended to the example section of elemwise_add op in

Re: direction for documentation across various APIs that share common doc source

Mu, Thanks for your response. I have some follow-up questions now. A lot actually. Can you explain more about what ndarray_doc.py is doing? I see that ndarray.register is calling it to do some transformations to docstrings by injecting "float". This seems quite buried to me. Some may have wondered

Re: direction for documentation across various APIs that share common doc source

The original design is putting psudo-code in cc files (e.g. ndarray.cc ) that are languange indepent, then having python codes in .py files (e.g. ndarray_doc.py

Re: direction for documentation across various APIs that share common doc source

Hey Aaron and Anton, One of MXNet's strengths over other frameworks is the plethora of language bindings so having language specific examples is of importance. Perhaps indicating that an example is Python code by using a "#python" header on the example would make it clear. Of course, for the

Re: direction for documentation across various APIs that share common doc source

Hi Aaron, Here is an idea: The main documentation is the one in .cc files. In theory the language bindings should just override some stuff from it, like examples. If I understand correctly there is a sphinx script that generates the documentation. If run it first for core src folder and then from

direction for documentation across various APIs that share common doc source

Hi everyone, A recent issue and pending PR has brought a thorny docs situation to my attention again and I'd like to hear from the community on how to proceed. We currently get some of the docs for the Python API pulled out of .cc files. Other APIs also get docs from there, or pull the Python docs