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/10/23 17:20:00 UTC
[jira] [Updated] (MXNET-961) MXNet-R API docs should be available
in HTML
[ https://issues.apache.org/jira/browse/MXNET-961?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Aaron Markham updated MXNET-961:
--------------------------------
Description:
Currently the website hosts a pdf file as a reference manual for the R API to MXNet.
It is not refreshed automatically. It hasn't been updated for several months.
Ideally this content should be in html and updated as part of the docs pipeline.
You can build the docs like this:
sudo apt-get install \
texinfo \
texlive \
texlive-fonts-extra
You will also need to enable R docs in settings.ini. For your own dev branch you would change the default section like so:
[document_sets_default]
clojure_docs = 0
doxygen_docs = 0
r_docs = 1
scala_docs = 0
The output is a .pdf file that can be found at docs/api/r/mxnet-r-reference-manual.pdf.
How to test the settings file
Assuming you have the setup defined previously, and say you're testing the settings file and you want to make sure it is running the right API docs for that version:
# Use the `BUILD_VER` flag and pass in the value of the version you want to test. By default, by not specifying BUILD_VER, you're running your current branch, therefore the `document_sets_default` settings in `settings.ini`. For example, to specifically test the build steps for version 1.0.0:
make html USE_OPENMP=1 BUILD_VER=1.0.0
was:
Currently the website hosts a pdf file as a reference manual for the R API to MXNet.
It is not refreshed automatically. It hasn't been updated for several months.
Ideally this content should be in html and updated as part of the docs pipeline.
> MXNet-R API docs should be available in HTML
> --------------------------------------------
>
> Key: MXNET-961
> URL: https://issues.apache.org/jira/browse/MXNET-961
> Project: Apache MXNet
> Issue Type: Improvement
> Reporter: Aaron Markham
> Priority: Minor
>
> Currently the website hosts a pdf file as a reference manual for the R API to MXNet.
> It is not refreshed automatically. It hasn't been updated for several months.
> Ideally this content should be in html and updated as part of the docs pipeline.
> You can build the docs like this:
>
> sudo apt-get install \
> texinfo \
> texlive \
> texlive-fonts-extra
> You will also need to enable R docs in settings.ini. For your own dev branch you would change the default section like so:
> [document_sets_default]
> clojure_docs = 0
> doxygen_docs = 0
> r_docs = 1
> scala_docs = 0
> The output is a .pdf file that can be found at docs/api/r/mxnet-r-reference-manual.pdf.
> How to test the settings file
> Assuming you have the setup defined previously, and say you're testing the settings file and you want to make sure it is running the right API docs for that version:
> # Use the `BUILD_VER` flag and pass in the value of the version you want to test. By default, by not specifying BUILD_VER, you're running your current branch, therefore the `document_sets_default` settings in `settings.ini`. For example, to specifically test the build steps for version 1.0.0:
> make html USE_OPENMP=1 BUILD_VER=1.0.0
--
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