Skip to content

Commit

Permalink
Merge pull request #352 from chrispyles/update-tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
chrispyles authored Aug 28, 2021
2 parents e3873f2 + 86bac7d commit 2cfb5a6
Show file tree
Hide file tree
Showing 5 changed files with 218 additions and 69 deletions.
Binary file modified docs/_static/tutorial.zip
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/otter_assign/v0/python_notebook_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Assign; optionally, you can specify these via the command line with the ``--user
.. code-block:: python
from otter.generate.token import APIClient
print(APIClient.get_token())
print(APIClient.get_token())
Any configurations in your ``generate`` key will be put into an ``otter_config.json`` and used when
running Otter Generate.
Expand Down
2 changes: 1 addition & 1 deletion docs/otter_assign/v1/notebook_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Assign; optionally, you can specify these via the command line with the ``--user
.. code-block:: python
from otter.generate.token import APIClient
print(APIClient.get_token())
print(APIClient.get_token())
Any configurations in your ``generate`` key will be put into an ``otter_config.json`` and used when
running Otter Generate.
Expand Down
20 changes: 7 additions & 13 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,20 @@ Otter Assign on this notebook, run

.. code-block:: console
$ otter assign demo.ipynb dist
$ otter assign demo.ipynb dist --v1
Generating views...
Generating solutions PDF...
Generating autograder zipfile...
Running tests...
All tests passed!
The use of the ``--v1`` flag indicates that this is an :ref:`Otter Assign format v1 formatted
notebook <otter_assign>`.

Otter Assign should create a ``dist`` directory which contains two further subdirectories:
``autograder`` and ``student``. The ``autograder`` directory contains the Gradescope autograder,
solutions PDF, and the notebook with solutions. The ``student`` directory contains just the
sanitized student notebook. Both contain a ``tests`` subdirectory that contains tests, but only
``autograder/tests`` has the hidden tests.
sanitized student notebook.

.. code-block::
Expand All @@ -65,17 +67,9 @@ sanitized student notebook. Both contain a ``tests`` subdirectory that contains
│ ├── demo-sol.pdf
│ ├── demo.ipynb
│ ├── otter_config.json
│ ├── requirements.txt
│ └── tests
│ ├── q1.py
│ ├── q2.py
│ └── q3.py
│ └── requirements.txt
└── student
├── demo.ipynb
└── tests
├── q1.py
├── q2.py
└── q3.py
└── demo.ipynb
For more information about the configurations for Otter Assign and its output format, see
:reF:`otter_assign`.
Expand Down
Loading

0 comments on commit 2cfb5a6

Please sign in to comment.