From 11e56e836e0a1c04fa64ddb8962b6cfd81a6ee4e Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 28 Jul 2025 10:37:32 +0200 Subject: [PATCH] Update 007.md --- book/exercises/007.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/book/exercises/007.md b/book/exercises/007.md index 0336bd1..d7b5256 100644 --- a/book/exercises/007.md +++ b/book/exercises/007.md @@ -1,6 +1,6 @@ # Exercise 8: 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. +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. ::::::{topic} Exercise objective Can you install and use a new Sphinx extension like `Sphinx-Indexed-Definitions` in your TeachBooks book? @@ -11,10 +11,10 @@ Can you install and use a new Sphinx extension like `Sphinx-Indexed-Definitions` 2. Add the following line to the bottom of the `requirements.txt` file: ``` - git+https://github.com/TeachBooks/Sphinx-Indexed-Definitions.git + sphinx-indexed-definitions ``` - This tells the build system to install the extension directly from GitHub. + This tells the build system to install the extension from PyPi, a repository which contains Python software 3. Next, open `_config.yml` and add the extension to your `sphinx` configuration block: @@ -26,7 +26,9 @@ Can you install and use a new Sphinx extension like `Sphinx-Indexed-Definitions` This ensures Sphinx loads the extension when building your book. -4. Now you can use the new directive provided by the extension. Try adding the following to one of your Markdown files in the `book/` directory: +4. Now you can use the new directive provided by the extension. First, read the documentation to understand how to apply it. In most cases, the documentation can be found in the README of the source repository of the software. For our example that is here: https://github.com/TeachBooks/Sphinx-Indexed-Definitions + +5. Try adding the following to one of your Markdown files in the `book/` directory: `````md ````{definition} Term @@ -36,7 +38,7 @@ Can you install and use a new Sphinx extension like `Sphinx-Indexed-Definitions` This will render a labelled, indexed definition that you can refer to from other parts of your book. -5. Try to reference the definition in another file using `{ref}` followed by the given label, as shown below: +6. Try to reference the definition in another file using `{ref}` followed by the given label, as shown below: ```md @@ -45,15 +47,14 @@ Can you install and use a new Sphinx extension like `Sphinx-Indexed-Definitions` This will appear as a hyperlink that takes the reader directly to the definition. -6. The same steps you followed here can be used to install any other extension of your choice. Simply add the extension to your `requirements.txt` (using either a GitHub link or PyPI package name), and list it under `extra_extensions` in `_config.yml`. Then use its features in your Markdown files according to the extension’s documentation. +7. The same steps you followed here can be used to install any other extension of your choice. Simply add the extension to your `requirements.txt` (using either a GitHub link or PyPI package name), and list it under `extra_extensions` in `_config.yml`. Then use its features in your Markdown files according to the extension’s documentation. Check out the ever-growing list of TeachBooks extensions in the [TeachBooks manual](https://teachbooks.io/manual/features/overview.html)! +8. When you are ready, commit your changes to the repository by clicking on the green `Commit changes` button. -7. When you are ready, commit your changes to the repository by clicking on the green `Commit changes` button. +9. Add a commit message. -8. Add a commit message. - -9. To see your changes, go to {octicon}`play;1em` `Actions` - The most recent workflow run `overview.md / the commit message of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root` (getting bored of waiting? There'll be exercising on doing this locally which prevents you from waiting). -10. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page. +10. To see your changes, go to {octicon}`play;1em` `Actions` - The most recent workflow run `overview.md / the commit message of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root` (getting bored of waiting? There'll be exercising on doing this locally which prevents you from waiting). +11. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page. ```{admonition} Check your understanding