diff --git a/.coderabbit.yaml b/.coderabbit.yaml index c2c7cf1c..f5bd95f1 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -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 diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 48c10e2d..8d09b003 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -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 diff --git a/README.md b/README.md index a0f1ba30..bbe6c4dd 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/algolia-config.json b/algolia-config.json index d030b0d2..a02b8995 100644 --- a/algolia-config.json +++ b/algolia-config.json @@ -18,4 +18,4 @@ "lvl5": "main h6", "text": "main p, main li, main blockquote, main td" } -} +} \ No newline at end of file diff --git a/find_unused_images.py b/find_unused_images.py index a088f572..0d7a9ea5 100644 --- a/find_unused_images.py +++ b/find_unused_images.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 ''' python find_unused_images.py python find_unused_images.py --delete @@ -5,7 +6,6 @@ python find_unused_images.py --debug ''' -#!/usr/bin/env python3 import argparse import csv import os diff --git a/source/conf.py b/source/conf.py index f46ec208..9722bb1c 100644 --- a/source/conf.py +++ b/source/conf.py @@ -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/' diff --git a/source/img/enable-shared-storage.png b/source/img/enable-shared-storage.png new file mode 100644 index 00000000..77734c79 Binary files /dev/null and b/source/img/enable-shared-storage.png differ diff --git a/source/img/guides/math-code-block.png b/source/img/guides/math-code-block.png new file mode 100644 index 00000000..021c9bd0 Binary files /dev/null and b/source/img/guides/math-code-block.png differ diff --git a/source/img/storage-assignment.png b/source/img/storage-assignment.png new file mode 100644 index 00000000..f3704ca2 Binary files /dev/null and b/source/img/storage-assignment.png differ diff --git a/source/img/storage-browser.png b/source/img/storage-browser.png new file mode 100644 index 00000000..cef97e37 Binary files /dev/null and b/source/img/storage-browser.png differ diff --git a/source/instructors/authoring/guides/intro.rst b/source/instructors/authoring/guides/intro.rst index eb3dc92e..b95739b1 100644 --- a/source/instructors/authoring/guides/intro.rst +++ b/source/instructors/authoring/guides/intro.rst @@ -18,7 +18,6 @@ Authoring authoring_guidelines markdown_content previewing_content - html_content teacher_only solution_templating freeze_code diff --git a/source/instructors/authoring/guides/markdown_content.rst b/source/instructors/authoring/guides/markdown_content.rst index 5a5d9fde..9294ae33 100644 --- a/source/instructors/authoring/guides/markdown_content.rst +++ b/source/instructors/authoring/guides/markdown_content.rst @@ -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 ************** diff --git a/source/instructors/getstarted/support/changelog.rst b/source/instructors/getstarted/support/changelog.rst index 6fb518c7..edbf7850 100644 --- a/source/instructors/getstarted/support/changelog.rst +++ b/source/instructors/getstarted/support/changelog.rst @@ -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` to courses. +- `[I] [20th]`: Added support for the `math` :ref:`markdown block` using LaTeX. - `[F] [17th]`: Add Ability to :ref:`Auto-Grade using an LLM-based rubric grader ` - `[I] [14th]`: Behavior insight information is available in the assignment CSV file. :ref:`Assignment data ` - `[I] [9th]`: New Guides button for :ref:`uploading files`. diff --git a/source/instructors/setupcourses/common-storage.rst b/source/instructors/setupcourses/common-storage.rst index d51269c7..6a9041c3 100644 --- a/source/instructors/setupcourses/common-storage.rst +++ b/source/instructors/setupcourses/common-storage.rst @@ -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 diff --git a/student-source/conf.py b/student-source/conf.py index fbe5e36b..8364e0d4 100644 --- a/student-source/conf.py +++ b/student-source/conf.py @@ -65,7 +65,7 @@ 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', - 'recommonmark', + 'sphinx_design', 'sphinx_sitemap' ] html_baseurl = 'https://docs.codio.com/'