Update documentation for nbgrader as a webapp #786
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
willingc
approved these changes
Jul 7, 2017
| assignment and grading tasks using the familiar Jupyter notebook interface. | ||
| For example, creating an assignment has the following workflow: | ||
|
|
||
| The nbgrader toolbar extension for Jupyter notebooks guides the instructor |
| Instructor "formgrader" extension for Jupyter notebooks | ||
| ------------------------------------------------------- | ||
|
|
||
| The formgrader extension for the Jupyter notebook allows instructors to use |
| Student assignment list extension for Jupyter notebooks | ||
| ------------------------------------------------------- | ||
|
|
||
| Using the assignment list extension, students may conveniently view, fetch, |
| @@ -31,23 +31,16 @@ this was done using the ``nbgrader extension install`` command. However, moving | |||
| forward this is done using the ``jupyter nbextension`` and ``jupyter | |||
| serverextension`` commands. | |||
|
|
|||
| To install and enable all frontend nbextensions (*assignment list*, | |||
| *create assignment*, and *formgrader*) run:: | |||
| To install and enable all nbextensions (*assignment list*, *create assignment*, | |||
There was a problem hiding this comment.
I would bold these instead of italics.
| To work properly, the *assignment list* and *formgrader* extensions requires | ||
| both the nbextension and serverextension. The *create assignment* extension | ||
| only has an nbextension part. | ||
| To work properly, the *assignment list*, *formgrader*, and *validate* |
| @@ -85,16 +85,15 @@ work). | |||
| Configuration files | |||
| ~~~~~~~~~~~~~~~~~~~ | |||
|
|
|||
| You will almost always need a configuration file as you are using nbgrader. At a minimum, this configuration file will contain information such as the names of the assignments for your class and the names of your students (though you may also add these by hand using the command line, see :doc:`creating_and_grading_assignments`). A basic config file would live at ``{course_directory}/nbgrader_config.py`` and might look like: | |||
| You may need a configuration file as you are using nbgrader to customize | |||
| You may need a configuration file as you are using nbgrader to customize | ||
| nbgrader's behavior. If you are using nbgrader with :doc:`JupyterHub | ||
| </configuration/jupyterhub_config>`, you will at minimum need to set the course | ||
| id in the configuration file. A basic config file would live at |
There was a problem hiding this comment.
jupyterhub, jupyter, or nbgrader config file?
There was a problem hiding this comment.
Better to be overly specific when it comes to names of config files.
| You will almost always need a configuration file as you are using nbgrader. At a minimum, this configuration file will contain information such as the names of the assignments for your class and the names of your students (though you may also add these by hand using the command line, see :doc:`creating_and_grading_assignments`). A basic config file would live at ``{course_directory}/nbgrader_config.py`` and might look like: | ||
| You may need a configuration file as you are using nbgrader to customize | ||
| nbgrader's behavior. If you are using nbgrader with :doc:`JupyterHub | ||
| </configuration/jupyterhub_config>`, you will at minimum need to set the course |
There was a problem hiding this comment.
...you will at minimum need must set the course id in the nbgrader_config.py configuration file.
|
Thanks, @willingc , great comments! I'll address these now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the relevant docs for #782
I also included a few other minor changes to the docs that I noticed while I was working on this.
@willingc if you'd be willing to look at this that would be fantastic!