-
Notifications
You must be signed in to change notification settings - Fork 6.8k
[WIP] New Website: New Docs [1/3] #15884
[WIP] New Website: New Docs [1/3] #15884
Conversation
Co-authored-by: Thomas Delteil <thomas.delteil1@gmail.com> Co-authored-by: Aaron Markham <markhama@amazon.com>
|
||
# Installing MXNet on Windows | ||
|
||
The following describes how to install with pip for computers with CPUs, Intel CPUs, and NVIDIA GPUs. Further along in the document you can learn how to build MXNet from source on Windows, or how to install packages that support different language APIs to MXNet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: you'll learn how to build MXNet ..., and how to install (and vs or)
@ThomasDelteil do we have a time schedule for website changing? |
Hey @pengzhao-intel, thanks for reaching out! :) Feel free to open PRs against this branch on my fork for adding new content. |
Thanks, @ThomasDelteil @xinyu-intel @TaoLv please take a look at the new website and we need to move our documents in new home :) |
@sandeep-krishnamurthy do we have the plan to put the unified dashboard #15757 into the new website? |
I fixed one license issue, but now another popped up. I think that RAT checker just bails once it finds one issue instead of telling you the totality of files that need licenses. I'm going to ignore this check for now. |
Hi, is it possible to make API docs easier to find ? I have to click many times to get to the function page: Main page -> Docs & Tutorials -> Python API Reference -> Python API -> mxnet.ndarray -> NDArray -> mxnet.ndarray.NDArray.dtype. |
docs/python_docs/README.md
Outdated
@@ -0,0 +1,10 @@ | |||
# README |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should update this...
This allows things to coexist until a following PR deletes this file.
I have updates pending for the license headers. |
@ThomasDelteil I think that the static site should get its own license file originating from whatever theme or source this started from... otherwise each file in that subdir is going to need licenses. Seems easier to just drop a LICENSE file in there... wdyt? For now, I'm excluding scanning docs/static_site, going with the assumption that this will be true. I did this for the theme because it has a license file in there. |
CI fails the sanity test due to RAT license check. |
add licenses and excludes
Leaving this here for reference... come to find out, you cannot exclude subfolders. The rat checker only seems to accept one folder, like |
* Adding new website files Co-authored-by: Thomas Delteil <thomas.delteil1@gmail.com> Co-authored-by: Aaron Markham <markhama@amazon.com> * add license header * fixing links and url + css * fixing tutorials * exclude python_docs folder when building prod site This allows things to coexist until a following PR deletes this file. * license header fixes * exclude static site from license header check * exclude static site and sphinx theme * exclude static_site and cpp_docs from sphinx * add licenses and excludes
* Adding new website files Co-authored-by: Thomas Delteil <thomas.delteil1@gmail.com> Co-authored-by: Aaron Markham <markhama@amazon.com> * add license header * fixing links and url + css * fixing tutorials * exclude python_docs folder when building prod site This allows things to coexist until a following PR deletes this file. * license header fixes * exclude static site from license header check * exclude static site and sphinx theme * exclude static_site and cpp_docs from sphinx * add licenses and excludes
Adding new files for the new website
Website can be seen here: https://thomasdelteil.github.io/mxnet.io-v2/
docs/python_docs
: New python website, a port + cosmetic changes from https://github.com/mli/new-docsdocs/static_site
: New Jekyll static site, with the tutorials from other languages and content from old website ported to the new formatdocs/cpp_docs
: Folder to hold on the Doxyfile and Makefile to build the CPP docs.Known issues: