[jira] [Comment Edited] (MXNET-959) Test m2r

["Aaron Markham (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MXNET-959?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16628109#comment-16628109 ] 

Aaron Markham edited comment on MXNET-959 at 9/26/18 5:02 PM:
--------------------------------------------------------------

I installed m2r and added it to /docs/conf.py like this:

extensions = [

    'sphinx.ext.autodoc',

    'sphinx.ext.autosummary',

    'sphinx.ext.napoleon',

    'sphinx.ext.mathjax',

    'sphinx.ext.viewcode',

    'breathe',

    'm2r',

    'mxdoc'

]

I removed recommonmark from conf.py.

Then I removed the following from /docs/mxdoc.py:

app.add_transform(transform.AutoStructify)

If I didn't the build would not finish. Once I did however, the API sections were no longer rendering automatically, even though the markdown was getting converted successfully.

Here is a preview:

The rst markup isn't rendering after I removed recommonmark and enabled m2r.

[http://34.201.8.176/versions/m2r/api/python/autograd/autograd.html#mxnet.autograd.predict_mode]

 


was (Author: aaronmarkham):
Here is a preview:

The Sphinx markup isn't rendering after I removed recommonmark and enabled m2r.

http://34.201.8.176/versions/m2r/api/python/autograd/autograd.html#mxnet.autograd.predict_mode

> Test m2r
> --------
>
>                 Key: MXNET-959
>                 URL: https://issues.apache.org/jira/browse/MXNET-959
>             Project: Apache MXNet
>          Issue Type: Task
>          Components: CI Build 
>            Reporter: Aaron Markham
>            Assignee: Aaron Markham
>            Priority: Major
>              Labels: documentation
>
> Deploy and test m2r: [https://github.com/miyakogi/m2r]
> This module converts markdown to rst.
> Assess its suitability for replacing recommonmark in the docs build pipeline.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@mxnet.apache.org
For additional commands, e-mail: issues-help@mxnet.apache.org