mxnet-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Aaron Markham (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (MXNET-957) Upgrade documentation pipeline
Date Wed, 19 Sep 2018 17:37:00 GMT

     [ https://issues.apache.org/jira/browse/MXNET-957?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Aaron Markham updated MXNET-957:
--------------------------------
    Description: 
Various modules in the documentation pipeline are quite old and missing important functionality.

Localization of the website will be easier if we're using a more modern version of Sphinx.

Of note, Sphinx is pinned at v1.5.6 because of a recommonmark integration that is not compatible
with newer versions of Sphinx.

Newer versions of Sphinx (1.6.x+) will provide advanced file include capabilities via integration
with docutils. 

File includes will help with maintaining the site by reducing duplication of content. Duplicated
content leads to inaccurate content as some parts get updated when others don't.

The [documentation pipeline is described in detail on the cwiki|https://cwiki.apache.org/confluence/display/MXNET/How+to+Build+the+Website].

 

  was:
Various modules in the documentation pipeline are quite old and missing important functionality.

Of note, Sphinx is pinned at v1.5.6 because of a recommonmark integration that is not compatible
with newer versions of Sphinx.

Newer versions of Sphinx (1.6.x+) will provide advanced file include capabilities via integration
with docutils. 

File includes will help with maintaining the site by reducing duplication of content. Duplicated
content leads to inaccurate content as some parts get updated when others don't.

The [documentation pipeline is described in detail on the cwiki|https://cwiki.apache.org/confluence/display/MXNET/How+to+Build+the+Website].

 


> Upgrade documentation pipeline
> ------------------------------
>
>                 Key: MXNET-957
>                 URL: https://issues.apache.org/jira/browse/MXNET-957
>             Project: Apache MXNet
>          Issue Type: Epic
>            Reporter: Aaron Markham
>            Assignee: Aaron Markham
>            Priority: Major
>              Labels: documentation
>
> Various modules in the documentation pipeline are quite old and missing important functionality.
> Localization of the website will be easier if we're using a more modern version of Sphinx.
> Of note, Sphinx is pinned at v1.5.6 because of a recommonmark integration that is not
compatible with newer versions of Sphinx.
> Newer versions of Sphinx (1.6.x+) will provide advanced file include capabilities via
integration with docutils. 
> File includes will help with maintaining the site by reducing duplication of content.
Duplicated content leads to inaccurate content as some parts get updated when others don't.
> The [documentation pipeline is described in detail on the cwiki|https://cwiki.apache.org/confluence/display/MXNET/How+to+Build+the+Website].
>  



--
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


Mime
View raw message