7.1. sphinx-exercise

De uitbreiding Sphinx-exercise maakt het mogelijk om opdrachten te formuleren en de uitwerkingen daarvan. Voor de officiële documentatie, zie: https://ebp-sphinx-exercise.readthedocs.io/en/latest/

7.1.1. Installatie en configuratie

• zie voor de installatie op je eigen computer: https://ebp-sphinx-exercise.readthedocs.io/en/latest/

• de uitbreiding is geïnstalleerd op de Jupyter Hub voor auteurs

Instelling in _config:

sphinx:
  extra_extensions:
    - sphinx_exercise
  config:
    numfig_format:
      exercise: "Opdracht %s"

De numfig_format-instelling zorgt voor de Nederlandse naam “Opdracht” in plaats van “Exercise”.

7.1.2. Syntax

Een opdracht heeft de vorm van een speciaal blok met een verplichte titel. Deze titel wordt ook gebruikt bij de verwijzing van de oplossing naar de opdracht. Als je later een uitwerking toe wilt voegen, geef je de opdracht een uniek label.

:::{exercise} titel van de opdracht
:label: my-exercise-1234

Omschrijving van de opdracht. Deze omschrijving kan ook figuren bevatten, en eventueel code blokken.

:::

Dit geeft het volgende resultaat:

Opdracht 7.1 (titel van de opdracht)

Omschrijving van de opdracht. Deze omschrijving kan ook figuren bevatten, en eventueel code blokken.

De uitwerking kun je op een andere plek in het Jupyter Book maken. Deze bevat dan een verwijzing naar de oorspronkelijke opdracht.

:::{solution} my-exercise-1234

Omschrijving van de uitwerking. Deze omschrijving kan ook figuren bevatten, en eventueel code blokken.

:::

Solution to Exercise 7.1 (titel van de opdracht)

Omschrijving van de uitwerking. Deze omschrijving kan ook figuren bevatten, en eventueel code blokken.

7.1.3. Opmerkingen

• opdrachten worden genummerd per hoofdstuk. Dat maakt het gemakkelijker om een hoofdstuk toe te voegen of weg te laten, bijvoorbeeld als je als docent het materiaal aanpast voor je eigen leerlingen.