-
Notifications
You must be signed in to change notification settings - Fork 317
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create a Contributor Guide in docs #402
Conversation
Great! You can convert the markdown to rst with pandoc pretty easily, I think |
220e044
to
8740a6e
Compare
@jhamrick Ready for review. I converted the markdown to rst, added subsection titles, and made some edits for organizational flow. On a separate topic, I've been building with Sphinx and the make file. I forgot there was invoke docs. I did get an error about invoke docs running and I'm wondering if you noticed that too. Since this pr has no ipynb files, there was no need to invoke clear_docs. I will investigate when I return. |
You will use ``pip3`` to install `flit <https://github.com/takluyver/flit>`_ | ||
and then use ``flit`` to install and build nbgrader:: | ||
|
||
pip3 install flit |
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.
Thanks to #409 this can just be one line instead of two, and it can be:
python setup.py develop
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.
You can also remove the bit about python 3, see the changes here: https://github.com/jupyter/nbgrader/pull/409/files#diff-6a3371457528722a734f3c51d9238c13L36
This looks great, thanks! Just a few small comments that I left inline. |
8740a6e
to
53f89b2
Compare
@jhamrick Changes made. I like the simplified install 🐶 |
@jhamrick Sorry about the backticks. Your tip on markdown vs. rst was appreciated. Honestly, the oversight was me rushing on the |
Looks good, thanks! |
Create a Contributor Guide in docs
This is an initial step of moving information contained in CONTRIBUTING.md to a Contributor Guide to be hosted as part of the nbgrader docs hosted on Read the Docs.
The file structure and indices have been set up. The docs still need conversion from markdown to rst.
As discussed in #401 and #392.