You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@mxnet.apache.org by "Aaron Markham (JIRA)" <ji...@apache.org> on 2018/09/18 00:35:00 UTC
[jira] [Commented] (MXNET-956) Rewrite installation nightly tests
[ https://issues.apache.org/jira/browse/MXNET-956?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16618320#comment-16618320 ]
Aaron Markham commented on MXNET-956:
-------------------------------------
I think that testing installation info by parsing it from documentation is a brittle, error-prone prospect. Writers, such as myself, or other contributors that don't know about the parsing might very easily make a change to the docs for clarity and fullness, or remove items, without keeping the parsing in mind. The primary role of the docs is to educate the user, not to facilitate testing.
I think, however, there could be a middle ground if we make use of "includes". Sphinx has a feature that allows you to include a document inside another document. If we create some simple installation scripts, these documents can be "included" in the installation documentation.
Something like this:
```install/scripts/pip_cuda92.txt
pip install mxnet_cu92
```
Then in the documentation we use this kind of Sphinx command:
```
Lorem ipsum installum:
.. include:: ../pip_cuda92.txt
Lorem ipsum verifyum...
```
This makes it clear to the documentation editor that the command(s) should come from an external file. They will be rendered when the site is built.
Then the engineer that handles CI, benchmarking or whatever, can hook their scripts into the external file, and totally bypass the markdown files with the documentation.
> Rewrite installation nightly tests
> ----------------------------------
>
> Key: MXNET-956
> URL: https://issues.apache.org/jira/browse/MXNET-956
> Project: Apache MXNet
> Issue Type: Story
> Reporter: Aaron Markham
> Priority: Major
>
> Several of the nightly tests on the installation docs have been disabled. Here's one example:
> [https://github.com/apache/incubator-mxnet/pull/12571]
>
--
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