Skip to content
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

Merged
merged 4 commits into from
Sep 3, 2015
Merged

Conversation

willingc
Copy link
Member

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.

@jhamrick jhamrick added this to the 0.3.0 milestone Sep 1, 2015
@jhamrick
Copy link
Member

jhamrick commented Sep 1, 2015

Great!

You can convert the markdown to rst with pandoc pretty easily, I think pandoc --from markdown --to rst CONTRIBUTING.md.

@willingc willingc changed the title [WIP] Create a Contributor Guide in docs Create a Contributor Guide in docs Sep 2, 2015
@willingc
Copy link
Member Author

willingc commented Sep 2, 2015

@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
Copy link
Member

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

Copy link
Member

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

@jhamrick
Copy link
Member

jhamrick commented Sep 3, 2015

This looks great, thanks! Just a few small comments that I left inline.

@willingc
Copy link
Member Author

willingc commented Sep 3, 2015

@jhamrick Changes made. I like the simplified install 🐶

@willingc
Copy link
Member Author

willingc commented Sep 3, 2015

@jhamrick Sorry about the backticks. Your tip on markdown vs. rst was appreciated. Honestly, the oversight was me rushing on the ✈️ . Hopefully, channeling the 🐢 for a bit instead of the 🐇 has resulted in better attention to detail ;)

@jhamrick
Copy link
Member

jhamrick commented Sep 3, 2015

Looks good, thanks!

jhamrick added a commit that referenced this pull request Sep 3, 2015
Create a Contributor Guide in docs
@jhamrick jhamrick merged commit ed387f7 into jupyter:master Sep 3, 2015
@willingc willingc deleted the doc-contrib branch September 3, 2015 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants