Skip to content

Commit d141acd

Browse files
committed
update ChangeLog
1 parent bde2ad9 commit d141acd

File tree

3 files changed

+34
-3
lines changed

3 files changed

+34
-3
lines changed

docs/changelog.rst

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,36 @@
22
ChangeLog
33
#########
44

5-
***********
6-
0.1.0 (TBR)
7-
***********
5+
******************
6+
0.2.0 (2025-12-23)
7+
******************
8+
9+
Documentation
10+
=============
11+
12+
* Continue reworking the documentation.
13+
* Add option to render extra text before/after a part. The text is rendered as a template.
14+
* Parts can now have an ID that you can reference when rendering parts to make sure that you render what
15+
you actually think you render (useful for longer tutorials).
16+
* Add ``structured_tutorials_context`` option to pass extra context variables to a tutorial.
17+
* Rename the ``tutorial_root`` option to ``structured_tutorials_root``.
18+
* rename the ``structured_tutorial_command_text_width`` option to ``structured_tutorials_command_text_width``.
19+
20+
Command-line
21+
============
22+
23+
* Add option ``--define {key} {value}`` to pass extra context variables.
24+
* Greatly improve error handling.
25+
* Parts can now have a name that is shown before running a tutorial part.
26+
* Add option to clear the environment for a command.
27+
* Add option to add extra environment variables for a command. Environment variables are rendered as
28+
templates.
29+
* Add ability to pass input to a process.
30+
* Command output can now also be tested for line or character count. You can specify an exact match, or a
31+
minimum and/or maximum.
32+
33+
******************
34+
0.1.0 (2025-12-22)
35+
******************
836

937
Initial version.

docs/spelling_wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ sudo
66
hostname
77
cwd
88
backend
9+
reStructuredText

docs/tutorials/templates/tutorial.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ parts:
2828
destination: "{{ dest }}/{{ filename }}"
2929
doc:
3030
language: json
31+
# If you use sphinxcontrib-spelling, make sure the filename is not spell-checked
32+
ignore_spelling: true
3133
- commands:
3234
- command: cat {{ dest }}/{{ filename }}
3335
doc:

0 commit comments

Comments
 (0)