well, in case of MXNet, it's mixed with MD and RST. The docs under dir `docs/` is written in MD. (MD is supported via sphinx plugin.)
For the function docstring in Python, it's written in RST. The docstring will be rendered via a sphinx feature -- "autodoc". You can check this as an example: https://github.com/apache/incubator-mxnet/blob/master/docs/api/python/autograd/autograd.md#api-reference Iblis Lin 林峻頤 On 1/23/19 11:16 PM, Pedro Larroy wrote:
I'm still refining the feature given some late feedback and that it will be public API. I guess with the help of Aaron we will get some nice documentation in, as it's not showing up in the master python API docs. I thought it would be taken automatically from the Python doc. Is this a correct source for the documentation format that we are using? I know we use sphynx but doesn't look like RST to me: http://www.sphinx-doc.org/en/master/usage/quickstart.html Pedro.