Skip to content
Open
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
6 changes: 5 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@
:class: bi-terminal-fill
.. role:: important
:class: important

.. This comment prevents the last role directive above from consuming
the first indented content of RST source files as directive content
(a Sphinx 7 stricter parsing behaviour).
'''

# If extensions (or modules to document with autodoc) are in another directory,
Expand Down Expand Up @@ -112,7 +116,7 @@
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'
root_doc = 'index'

# General information about the project.
project = 'Aplus manual'
Expand Down
2 changes: 0 additions & 2 deletions point_of_interest/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,6 @@ You can see some use cases in the examples below.
.. column::
:column-class: text-center bg-danger-subtle


.. row::

.. column::
Expand Down Expand Up @@ -765,4 +764,3 @@ Use ``:no_poi_box:`` option if you want to create POI that does not pop up from
:no_poi_box:

This content is blended with the rest of the content in the A+ course material.

34 changes: 18 additions & 16 deletions programming_exercises/grader_submission_tags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,31 @@ In grading containers, the submission tags can be set by outputting them directl
Below are the detailed methods for setting submission tags.

1. **Setting submission tags by output**:
- This method involves printing the submission tags along with the points and maximum points.
- Example (in Python unittests):

.. code-block:: python
- This method involves printing the submission tags along with the points and maximum points.
- Example (in Python unittests):

...
submission_tags = "tag1slug,tag2slug"
print(f"TotalPoints: {result.points}\nMaxPoints: {result.max_points}\nSubmissionTags: {submission_tags}")
.. code-block:: python

...
submission_tags = "tag1slug,tag2slug"
print(f"TotalPoints: {result.points}\nMaxPoints: {result.max_points}\nSubmissionTags: {submission_tags}")

2. **Setting submission tags by writing to a file**:
- This method requires writing the submission tags to a specific file (`/feedback/submission_tags`) and is typically used when tests are run with root user permissions.
- Example (in Python unittests):

.. code-block:: python
- This method requires writing the submission tags to a specific file (`/feedback/submission_tags`) and is typically used when tests are run with root user permissions.
- Example (in Python unittests):

.. code-block:: python

...
submission_tags = "tag1slug,tag2slug"
with open("/feedback/points", "w") as f:
f.write(f"{result.points}/{result.max_points}")
with open("/feedback/submission_tags", "w") as f:
f.write(submission_tags)
...
submission_tags = "tag1slug,tag2slug"
with open("/feedback/points", "w") as f:
f.write(f"{result.points}/{result.max_points}")
with open("/feedback/submission_tags", "w") as f:
f.write(submission_tags)

- Ensure that the tests are executed with the necessary permissions to write to the `/feedback` directory.
- Ensure that the tests are executed with the necessary permissions to write to the `/feedback` directory.

**Important notes**:

Expand Down
2 changes: 1 addition & 1 deletion programming_exercises/radar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ inspect the results in the Radar service.
.. _Radar: https://github.com/apluslms/radar

Dolos integration
----------------
-----------------

Dolos is a modern service for generating similarity reports for source code. It is open source
and the code is available `here <https://github.com/dodona-edu/dolos>`_. A local Dolos instance is running
Expand Down
8 changes: 4 additions & 4 deletions rst_guide/advanced_syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Code example

.. code-block:: rst

.. container:: admonition success
.. container:: admonition success

.. div:: row

Expand Down Expand Up @@ -644,7 +644,7 @@ All of this is possible thanks to the built-in options of the ``code-block`` dir
Literal include
...............

The ``literalinclude`` directive allows you to include code files and show then as snippets of code within the course content.
The ``literalinclude`` directive allows you to include code files and show them as snippets of code within the course content.
This is ideal for showing code examples stored in external files.
In addition, this directive allows to emulate file comparison.

Expand Down Expand Up @@ -693,7 +693,7 @@ The literalinclude :important:`syntax` consists of the directive name, the filep
:prepend: # Prepended comment
:append: # Appended comment
:linenos:
:lines: 1-5,7-11
:lines: 1-5,7-9


.. tab-content:: tab2-include
Expand All @@ -713,7 +713,7 @@ The literalinclude :important:`syntax` consists of the directive name, the filep
:prepend: # Prepended comment
:append: # Appended comment
:linenos:
:lines: 1-5,7-11
:lines: 1-5,7-9

.. rst-class:: text-end

Expand Down