Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .coderabbit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,14 @@ reviews:
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.
- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
path_filters:
- "!**/*.png"
finishing_touches:
unit_tests:
enabled: false
docstrings:
enabled: false
chat:
auto_reply: true
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Setup env
run: pip install sphinx==8.2.0 sphinxawesome-theme==5.3.2 sphinx-docsearch==0.1.0 sphinx-sitemap==2.9.0 sphinx_code_tabs==0.5.5 recommonmark==0.7.1
run: pip install sphinx==8.2.0 sphinxawesome-theme==5.3.2 sphinx-docsearch==0.1.0 sphinx-sitemap==2.9.0 sphinx_code_tabs==0.5.5 sphinx_design==0.6.1

- name: Checkout
uses: actions/checkout@v1
uses: actions/checkout@v4

- name: Build
run: make html
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If using Codio, put on the certified Python stack `Python Ubuntu 22.04 (pyenv)`.
### Install

```
pip install sphinx==8.2.0 sphinxawesome-theme==5.3.2 sphinx-docsearch==0.1.0 sphinx-sitemap==2.9.0 sphinx_code_tabs==0.5.5 recommonmark==0.7.1
pip install sphinx==8.2.0 sphinxawesome-theme==5.3.2 sphinx-docsearch==0.1.0 sphinx-sitemap==2.9.0 sphinx_code_tabs==0.5.5 sphinx_design==0.6.1
```

### Build
Expand Down
2 changes: 1 addition & 1 deletion algolia-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
"lvl5": "main h6",
"text": "main p, main li, main blockquote, main td"
}
}
}
2 changes: 1 addition & 1 deletion find_unused_images.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
#!/usr/bin/env python3
'''
python find_unused_images.py
python find_unused_images.py --delete
python find_unused_images.py --delete --yes
python find_unused_images.py --debug
'''

#!/usr/bin/env python3
import argparse
import csv
import os
Expand Down
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'recommonmark',
'sphinx_code_tabs',
'sphinx_design',
'sphinx_sitemap'
]
html_baseurl = 'https://docs.codio.com/'
Expand Down
Binary file added source/img/enable-shared-storage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/img/guides/math-code-block.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/img/storage-assignment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/img/storage-browser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion source/instructors/authoring/guides/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Authoring
authoring_guidelines
markdown_content
previewing_content
html_content
teacher_only
solution_templating
freeze_code
Expand Down
19 changes: 19 additions & 0 deletions source/instructors/authoring/guides/markdown_content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,25 @@ We can define a variable `var x;` if we like

We can define a variable \`var x;\` if we like

.. _math-blocks:

Math Blocks
*************

To add mathematical expressions, you can use the `math` block as follows:

.. code:: markdown

```math
F = G \frac{m_1 m_2}{r^2}
```

The example above will render:

.. image:: /img/guides/math-code-block.png
:alt: Newton's law of universal gravitation using the Math block.
:width: 60%
:align: center

Indented Lists
**************
Expand Down
3 changes: 2 additions & 1 deletion source/instructors/getstarted/support/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ We do not report small bug fixes or issues that affect individual users, who we

- `[I] [24th]`: Pyret support has been deprecated.
- `[I] [22nd]`: Pagination is now persistent across pages.
- `[I] [20th]`: Added support for the Math markdown code block.
- `[F] [21st]`: Added :ref:`Common Storage<common-storage>` to courses.
- `[I] [20th]`: Added support for the `math` :ref:`markdown block<math-blocks>` using LaTeX.
- `[F] [17th]`: Add Ability to :ref:`Auto-Grade using an LLM-based rubric grader <llm-based-rubric>`
- `[I] [14th]`: Behavior insight information is available in the assignment CSV file. :ref:`Assignment data <export-assignment>`
- `[I] [9th]`: New Guides button for :ref:`uploading files<upload-file-button>`.
Expand Down
57 changes: 54 additions & 3 deletions source/instructors/setupcourses/common-storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,59 @@

.. _common-storage:

Common Storage for Course
=========================
==========================
Common Storage for Courses
==========================

It is possible to create a shared storage for a course. With this feature, instructors can add files that will be available across all assignments for all students.
Course Shared Storage lets instructors place common files (docs, data sets, starter code, assets) in one location that's available inside every assignment workspace. Read-only files are securely shared and available for all students.

Key Benefits
------------
- Single source of truth for course assets
- No per-assignment re-uploads or duplication
- Consistent path for code and terminal access

|

====================
Using Common Storage
====================

Enable Course Shared Storage
----------------------------

1. Open the course and go to ``Admin → Course Details``.
2. Scroll to **Course Shared Storage** and toggle **Shared storage**: **On**.
3. Click **Save Changes**.

.. image:: /img/enable-shared-storage.png
:alt: Toggle to enable Course Shared Storage in Admin → Course Details
:width: 80%
:align: center

.. note:: Once enabled, you will see the **Storage** tab in the **Admin** area of the course.

Add Folders & Files
-------------------

1. Navigate to ``Admin → Storage``.
2. Use **Create Directory** to make a top-level folder (e.g., ``Assignment-1`` or ``Datasets``).
3. Select a folder, then use **Upload File** to add one or more files.
4. Repeat for additional assignments or resources as needed.

.. image:: /img/storage-browser.png
:alt: Storage browser showing a dataset folder with uploaded files
:width: 80%
:align: center

.. caution:: You can upload many files, but no single file can be more than 5 GB.

Access Storage From Assignments
-------------------------------

Inside any assignment workspace, the shared storage appears under the ``storage/`` directory. Students and teachers can read files from there with the terminal, editors, or program code.

.. image:: /img/storage-assignment.png
:alt: Storage section inside one assignment.
:width: 80%
:align: center
2 changes: 1 addition & 1 deletion student-source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'recommonmark',
'sphinx_design',
'sphinx_sitemap'
]
html_baseurl = 'https://docs.codio.com/'
Expand Down