You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2021/03/11 20:38:44 UTC
[GitHub] [incubator-mxnet] leezu opened a new pull request #20012: Update docs/README.md
leezu opened a new pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012
Update docs/README.md file following https://github.com/apache/incubator-mxnet/commit/c789d020449393f177d903515ff4f80a3f616bc6. That commit only updated docs/python_docs/README.md and missed the docs/README.md
Both files contained duplicate content. Resolve by linking in docs/README.md to docs/python_docs/README.md when Python docs are discussed.
Thanks @aaronmarkham for pointing out the problem
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] mxnet-bot commented on pull request #20012: Update docs/README.md
Posted by GitBox <gi...@apache.org>.
mxnet-bot commented on pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012#issuecomment-817960236
Jenkins CI successfully triggered : [unix-cpu]
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] szha commented on a change in pull request #20012: Update docs/README.md
Posted by GitBox <gi...@apache.org>.
szha commented on a change in pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012#discussion_r612685103
##########
File path: docs/README.md
##########
@@ -38,123 +38,20 @@ If you plan to contribute changes to the documentation or website, please submit
MXNet's Python documentation is built with [Sphinx](https://www.sphinx-doc.org) and a variety of plugins including [pandoc](https://pandoc.org/), and [recommonmark](https://github.com/rtfd/recommonmark).
-More information on the dependencies can be found in the [CI folder's installation scripts](https://github.com/apache/incubator-mxnet/tree/master/ci/docker/install/ubuntu_docs.sh).
-
-You can run just the Python docs by following the instructions in the Python API guide.
+You can run just the Python docs by following the instructions in the `python_docs/README.md`.
## Other API Docs
The docs are hosted on the website in each language API's section. You can find installation and build instructions there.
## How to Build the MXNet Website for Development and QA
-`conda` or `miniconda` is recommended.
-* [Conda](https://www.anaconda.com/distribution/#download-section) (install to PATH)
-
-If you only need to make changes to tutorials or other pages that are not generated from one of the API source code folders, then you can use a basic Python pip or conda installation. But if you want edit the API source and have the reference API docs update, you also need to build MXNet from source. Refer to the build from source instructions for this requirement.
-
-
-### Ubuntu Setup
-
-As this is maintained for CI, Ubuntu is recommended. Refer to [ubuntu_doc.sh](https://github.com/apache/incubator-mxnet/tree/master/ci/docker/install/ubuntu_docs.sh) for the latest install script.
+If you only need to make changes to tutorials or other pages that are not generated from one of the API source code folders, then you can install a pre-build MXNet binary. But if you want edit the API source and have the reference API docs update, you also need to build MXNet from source. Refer to the [build from source instructions for this requirement](https://mxnet.apache.org/versions/master/get_started/build_from_source.html).
Review comment:
The get_started page should work.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] mxnet-bot commented on pull request #20012: Update docs/README.md
Posted by GitBox <gi...@apache.org>.
mxnet-bot commented on pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012#issuecomment-817918569
Jenkins CI successfully triggered : [unix-cpu]
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] leezu commented on pull request #20012: Update docs/README.md
Posted by GitBox <gi...@apache.org>.
leezu commented on pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012#issuecomment-817918477
@mxnet-bot run ci [unix-cpu]
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] szha commented on a change in pull request #20012: Update docs/README.md
Posted by GitBox <gi...@apache.org>.
szha commented on a change in pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012#discussion_r612056863
##########
File path: docs/README.md
##########
@@ -38,123 +38,20 @@ If you plan to contribute changes to the documentation or website, please submit
MXNet's Python documentation is built with [Sphinx](https://www.sphinx-doc.org) and a variety of plugins including [pandoc](https://pandoc.org/), and [recommonmark](https://github.com/rtfd/recommonmark).
-More information on the dependencies can be found in the [CI folder's installation scripts](https://github.com/apache/incubator-mxnet/tree/master/ci/docker/install/ubuntu_docs.sh).
-
-You can run just the Python docs by following the instructions in the Python API guide.
+You can run just the Python docs by following the instructions in the `python_docs/README.md`.
## Other API Docs
The docs are hosted on the website in each language API's section. You can find installation and build instructions there.
## How to Build the MXNet Website for Development and QA
-`conda` or `miniconda` is recommended.
-* [Conda](https://www.anaconda.com/distribution/#download-section) (install to PATH)
-
-If you only need to make changes to tutorials or other pages that are not generated from one of the API source code folders, then you can use a basic Python pip or conda installation. But if you want edit the API source and have the reference API docs update, you also need to build MXNet from source. Refer to the build from source instructions for this requirement.
-
-
-### Ubuntu Setup
-
-As this is maintained for CI, Ubuntu is recommended. Refer to [ubuntu_doc.sh](https://github.com/apache/incubator-mxnet/tree/master/ci/docker/install/ubuntu_docs.sh) for the latest install script.
+If you only need to make changes to tutorials or other pages that are not generated from one of the API source code folders, then you can install a pre-build MXNet binary. But if you want edit the API source and have the reference API docs update, you also need to build MXNet from source. Refer to the [build from source instructions for this requirement](https://mxnet.apache.org/versions/master/get_started/build_from_source.html).
Review comment:
one more nitpick: there could be a link for "install a pre-build(t) MXNet binary" too
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] leezu commented on a change in pull request #20012: Update docs/README.md
Posted by GitBox <gi...@apache.org>.
leezu commented on a change in pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012#discussion_r612099247
##########
File path: docs/README.md
##########
@@ -38,123 +38,20 @@ If you plan to contribute changes to the documentation or website, please submit
MXNet's Python documentation is built with [Sphinx](https://www.sphinx-doc.org) and a variety of plugins including [pandoc](https://pandoc.org/), and [recommonmark](https://github.com/rtfd/recommonmark).
-More information on the dependencies can be found in the [CI folder's installation scripts](https://github.com/apache/incubator-mxnet/tree/master/ci/docker/install/ubuntu_docs.sh).
-
-You can run just the Python docs by following the instructions in the Python API guide.
+You can run just the Python docs by following the instructions in the `python_docs/README.md`.
## Other API Docs
The docs are hosted on the website in each language API's section. You can find installation and build instructions there.
## How to Build the MXNet Website for Development and QA
-`conda` or `miniconda` is recommended.
-* [Conda](https://www.anaconda.com/distribution/#download-section) (install to PATH)
-
-If you only need to make changes to tutorials or other pages that are not generated from one of the API source code folders, then you can use a basic Python pip or conda installation. But if you want edit the API source and have the reference API docs update, you also need to build MXNet from source. Refer to the build from source instructions for this requirement.
-
-
-### Ubuntu Setup
-
-As this is maintained for CI, Ubuntu is recommended. Refer to [ubuntu_doc.sh](https://github.com/apache/incubator-mxnet/tree/master/ci/docker/install/ubuntu_docs.sh) for the latest install script.
+If you only need to make changes to tutorials or other pages that are not generated from one of the API source code folders, then you can install a pre-build MXNet binary. But if you want edit the API source and have the reference API docs update, you also need to build MXNet from source. Refer to the [build from source instructions for this requirement](https://mxnet.apache.org/versions/master/get_started/build_from_source.html).
Review comment:
Would https://mxnet.apache.org/versions/master/get_started or pypi be more helpful?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] szha commented on a change in pull request #20012: Update docs/README.md
Posted by GitBox <gi...@apache.org>.
szha commented on a change in pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012#discussion_r612028171
##########
File path: docs/README.md
##########
@@ -38,123 +38,20 @@ If you plan to contribute changes to the documentation or website, please submit
MXNet's Python documentation is built with [Sphinx](https://www.sphinx-doc.org) and a variety of plugins including [pandoc](https://pandoc.org/), and [recommonmark](https://github.com/rtfd/recommonmark).
-More information on the dependencies can be found in the [CI folder's installation scripts](https://github.com/apache/incubator-mxnet/tree/master/ci/docker/install/ubuntu_docs.sh).
-
-You can run just the Python docs by following the instructions in the Python API guide.
+You can run just the Python docs by following the instructions in the `python_docs/README.md`.
## Other API Docs
The docs are hosted on the website in each language API's section. You can find installation and build instructions there.
## How to Build the MXNet Website for Development and QA
-`conda` or `miniconda` is recommended.
-* [Conda](https://www.anaconda.com/distribution/#download-section) (install to PATH)
-
-If you only need to make changes to tutorials or other pages that are not generated from one of the API source code folders, then you can use a basic Python pip or conda installation. But if you want edit the API source and have the reference API docs update, you also need to build MXNet from source. Refer to the build from source instructions for this requirement.
-
-
-### Ubuntu Setup
-
-As this is maintained for CI, Ubuntu is recommended. Refer to [ubuntu_doc.sh](https://github.com/apache/incubator-mxnet/tree/master/ci/docker/install/ubuntu_docs.sh) for the latest install script.
+If you only need to make changes to tutorials or other pages that are not generated from one of the API source code folders, then you can install a pre-build MXNet binary. But if you want edit the API source and have the reference API docs update, you also need to build MXNet from source. Refer to the build from source instructions for this requirement.
Review comment:
Would be great to add a link for "build from source"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] mxnet-bot commented on pull request #20012: Update docs/README.md
Posted by GitBox <gi...@apache.org>.
mxnet-bot commented on pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012#issuecomment-797033212
Hey @leezu , Thanks for submitting the PR
All tests are already queued to run once. If tests fail, you can trigger one or more tests again with the following commands:
- To trigger all jobs: @mxnet-bot run ci [all]
- To trigger specific jobs: @mxnet-bot run ci [job1, job2]
***
**CI supported jobs**: [website, unix-gpu, windows-cpu, centos-gpu, sanity, edge, clang, windows-gpu, unix-cpu, centos-cpu, miscellaneous]
***
_Note_:
Only following 3 categories can trigger CI :PR Author, MXNet Committer, Jenkins Admin.
All CI tests must pass before the PR can be merged.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] leezu commented on pull request #20012: Update docs/README.md
Posted by GitBox <gi...@apache.org>.
leezu commented on pull request #20012:
URL: https://github.com/apache/incubator-mxnet/pull/20012#issuecomment-817960198
@mxnet-bot run ci [unix-cpu]
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org