Skip to content

Commit b19a517

Browse files
committed
Documentation improvements and cleanup
- Renamed test file to test_exercise_style.py for consistency with new config name - Updated CHANGELOG.md to reflect correct exercise_style configuration - Fixed install.md to use modern pip editable install instead of deprecated setup.py - All 113 tests pass across Python 3.11-3.13 and Sphinx 6-8
1 parent 2decd14 commit b19a517

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

CHANGELOG.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@
44

55
### New ✨
66

7-
- Added `style_solution_after_exercise` configuration option to remove hyperlinks from solution titles when solutions follow exercises directly
8-
- Changed dropdown button text from "Click to show" to "Show" for cleaner visual appearance
7+
- Added `exercise_style` configuration option to control solution title styling
8+
- Set to `"solution_follow_exercise"` to remove hyperlinks from solution titles when solutions follow exercises directly
9+
- Default is `""` (empty string) which maintains the original clickable hyperlink behavior
10+
- Changed dropdown button text from "Click to show" to "Show" (and "Click to hide" to "Hide") for cleaner visual appearance
911

1012
### Improved 👌
1113

1214
- Enhanced solution title styling options for better UX in lecture-style content where solutions follow exercises
15+
- Improved configuration option naming for better clarity when used alongside other Sphinx extensions
1316

1417
## [v1.1.1](https://github.com/executablebooks/sphinx-exercise/tree/v1.1.1) (2025-10-23)
1518

docs/source/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ git clone https://github.com/executablebooks/sphinx-exercise
1616
then run:
1717

1818
```bash
19-
python setup.py install
19+
pip install -e .
2020
```
File renamed without changes.

0 commit comments

Comments
 (0)