Skip to content

Conversation

@eslesar-aws
Copy link
Contributor

The initial incremental move of docs from readme to the sphinx project.

  • created a new rst file using_mxnet.rst where I copied the existing content of src/mxnet/readme.rst
  • edited that content (roughly first half, including creating links to class and method documentation on first mention within a subtopic--open to feedback on this approach.
  • minor edits to index.rst and sagemaker.mxnet.rst to incorporate the new content in sphinx

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have updated the changelog with a description of my changes (if appropriate)
  • I have updated any necessary documentation (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@@ -1,6 +1,7 @@
MXNet
MXNet Objects
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe "Classes" instead?

laurenyu
laurenyu previously approved these changes Jan 31, 2019
@laurenyu
Copy link
Contributor

please update the PR title/commit message to an imperative statement (reference: How to Write a Git Commit Message)

@laurenyu laurenyu mentioned this pull request Jan 31, 2019
4 tasks
@eslesar-aws eslesar-aws changed the title Mxnet migrate Migrate MXNet documentation to sphinx project Jan 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants