Merge branch 'main' into Add_default_configuration_options

This commit is contained in:
Tom van Woudenberg 2025-09-17 18:37:47 +02:00 • committed by GitHub
commit 0c05e8096a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 265 additions and 13 deletions

View file

@ -1,4 +1,4 @@
# Exercise 8: Add extensions to your book
# Add extensions to your book
TeachBooks supports many useful extensions, but sometimes you may want more functionality. In this exercise, you'll learn how to add an external extension to your book that is not already built-in. We will use the [`Sphinx-Indexed-Definitions`](https://github.com/TeachBooks/Sphinx-Indexed-Definitions) extension as an example, which allows you to define glossary-style entries with indexed labels in an easy way.

View file

@ -15,9 +15,9 @@ Here is how these exercises relate to the workflow.
| :---: | :---: | :---: | :---: |
| 1 | Get and idea | 4 | Create an issue |
| 2 | Create _your_ version of the book | 4 | Create a branch |
| 3 | Edit the book | 1, 2, 3, 6, 8| Editing `.md`-files, the `_toc.yml` and the `_config.yml` |
| 4 | Check changes online | 1, 2, 3, 6, 8 | Workflows and Actions Summary |
| 5 | Repeat edit and checking | 1, 2, 3, 4, 5, 8 | Keep on doing all the steps until it's ready|
| 3 | Edit the book | 1, 2, 3, 6| Editing `.md`-files, the `_toc.yml` and the `_config.yml` |
| 4 | Check changes online | 1, 2, 3, 6| Workflows and Actions Summary |
| 5 | Repeat edit and checking | 1, 2, 3, 4, 5 | Keep on doing all the steps until it's ready|
| 6 | Submit for review | 5, 7 | Open and merge a Pull Request, from a branch or forks |
## Keep practicing