Skip to content

Latest commit

 

History

History
150 lines (86 loc) · 5.73 KB

CHANGELOG.md

File metadata and controls

150 lines (86 loc) · 5.73 KB
Raw

Changelog

v0.4.1 (2023-1-23)

Improved 👌

Compatibility with docutils>=0.18 (from support with sphinx>=5). Along with updating CI and pre-commit files.

v0.4.0 (2022-3-18)

New ✨

Added gated directive syntax for exercise and solution directives, which provides an alternative syntax for building exercise and solution that may also include executable code.

Example:

You may now use exercise-start and exercise-end to define the exercise which may include any type of text, directives and roles between the start and end markers.

```{exercise-start}
:label: ex1
```

```{code-cell}
# Some setup code that needs executing
```

and maybe you wish to add a figure

```{figure} img/example.png
```

```{exercise-end}
```

This can also be used with solution-start and solution-end.

See docs for further details

v0.3.1 (2022-2-01)

Fixes 🐛

  • 🐛 FIX: Check for sphinx_exercise_registry in all registered post_tranform
  • 🐛 FIX: Update style for solution titles

v0.3.0 (2021-12-07)

Improved 👌

This is a major release as the package was extensively refactored to improve maintainability. There are very few user facing changes. The styles have been updated when including a custom title to exercise admonitions.

Further details of the technical changes can be found here

v0.2.1 (2021-10-08)

New ✨

Added latex support for sphinx-exercise

Improved 👌

Refactored code to make it modular and robust, fixing some of the bugs mentioned below.

Fixes 🐛

  • Exercise node title now visible for sphinx > 3.2
  • Solution directive fix issue#32

v0.1.1 (2020-10-10)

Full Changelog

Improved 👌

Made bottom and top padding of directives the same as admonitions in order to fix any other padding issues when the directives use the dropdown class option. We also updated the link of the solution directive title to target only the exercise portion in order to avoid confusion.

Fixes 🐛

Fixed doctree-resolve method in the event the extension is imported but not used.

Documentation improvements 📚

Introduced documentation on how to hide directives.

Implemented enhancements:

  • Make bottom/top padding the same as admonitions #10

Closed issues:

  • [ENH] Add solution block with linking to an exercise #19

Merged pull requests:

  • 👌 IMPROVE: Link exercise portion of solution title in directive #20 (najuzilu)
  • 🚀 RELEASE: v0.1.0 #17 (najuzilu)
  • 🐛 FIX: Check during doctree-resolve if env has attribute #16 (najuzilu)
  • 👌 IMPROVE: Make padding the same as admonitions #15 (najuzilu)

v0.1.0 (2020-10-08)

Full Changelog

New ✨

sphinx-exercise incorporates GitHub Actions to build, test, and deploy our code.

Improved 👌

Reference placeholders such as {name} and {number} can be used simultaneously while %s works only if not referenced with other placeholders.

Fixes 🐛

  • Manifest path has been fixed to recursively include all CSS and JavaScript files.
  • Namespace was removed from setup.py.
  • ReadTheDocs builds documentation using a dev mode environment through the rtd extra.

Documentation improvements 📚

  • Typo fix #14 (@chrisjsewell)

Closed issues:

  • [DISC] Create a new role specific to this extension #3
  • EBP org? #1

Merged pull requests:

* This Changelog was automatically generated by github_changelog_generator