This commit is contained in:
Chris Pyles 2022-05-02 18:16:03 -07:00
Родитель 2533947888
Коммит a42153e9e4
4 изменённых файлов: 31 добавлений и 2 удалений

Просмотреть файл

@ -1,5 +1,5 @@
Command-Line Interface
======================
CLI Reference
=============
PyBryt includes a small command-line interface for performing quick tasks using its functionality.
The main tasks that the CLI currently supports are:

Просмотреть файл

@ -1,3 +1,5 @@
.. _github_action:
PyBryt GitHub Action
====================

Просмотреть файл

@ -19,6 +19,7 @@ PyBryt Documentation
github_action
cli_reference
api_reference
resources
Changelog <https://github.com/microsoft/pybryt/tree/main/CHANGELOG.md>
PyBryt is an open source Python auto-assessment library for teaching and

26
docs/resources.rst Normal file
Просмотреть файл

@ -0,0 +1,26 @@
Resources
=========
Take a look at the resources below to learn more about PyBryt and its applications.
* `Introduction to PyBryt Microsoft Learn Module
<https://docs.microsoft.com/learn/modules/introduction-pybryt/>`_: A Microsoft Learn module that
covers the basics of PyBryt, including annotations, annotation messages, and creating reference
implementations.
* `Advanced PyBryt Microsoft Learn Module
<https://docs.microsoft.com/learn/modules/advanced-pybryt/>`_: A Microsoft Learn module that
covers more advanced PyBryt topics than the intro module, including things like annotation
options, relational and complexity annotations, and grading pipelines.
* `PyBryt for Pedagogical Auto-assessment
<https://techcommunity.microsoft.com/t5/educator-developer-blog/pybryt-for-pedagogical-auto-assessment/ba-p/3263659>`_:
This is a short blog post that explains the core idea behind and rationale for PyBryt. It includes
a brief discussion of why PyBryt was created, an outline of how assignments work with PyBryt, and
testimonials from a pilot of PyBryt at Imperial College London.
* `Demos folder <https://github.com/microsoft/pybryt/tree/main/demo/>`_: This folder contains some
short demos of PyBryt assessing submissions for common algorithms. Each includes a notebook that
goes through the entire assessment process, from compiling references to generating reports.
* |microsoft/pybryt-action|_: This GitHub Action can be used to run PyBryt as CI in student repos.
You can also learn more about this action :ref:`on this page<github_action>`.
.. |microsoft/pybryt-action| replace:: ``microsoft/pybryt-action``
.. _microsoft/pybryt-action: https://github.com/microsoft/pybryt-action