Commit graph

1259 commits

Author SHA1 Message Date
Dennis den Ouden-van der Horst
1ac94844a3 Refactor directive name construction for clarity
Extracted suffix_separator, suffix_start, and suffix_end from cfg to local variables for improved readability and maintainability in directive name construction.
2026-01-03 12:50:11 +01:00
Dennis den Ouden-van der Horst
e12183af9e Refactor _should_skip_name for clarity and efficiency
Extracted suffix_separator, suffix_start, and suffix_end from cfg at the start of the function to avoid repeated dictionary lookups and improve code readability.
2026-01-03 12:48:34 +01:00
Dennis den Ouden-van der Horst
f4ea60d42c Enhance sphinx_gated_directives with configurable suffixes and override logic
Refactor the sphinx_gated_directives extension to support configurable suffixes and separator for start/end directives, and add an 'override_existing' option for more flexible directive registration. Update the registry naming and logic throughout the extension, add configuration validation, and update the book config and intro to demonstrate new exercise directives and nesting.
2026-01-03 12:45:24 +01:00
Dennis den Ouden-van der Horst
144c7a95be Refactor sphinx_gated_directives and update intro.md examples
Improved code structure and comments in sphinx_gated_directives/__init__.py, clarified logic, and removed unused/legacy code. Updated intro.md to remove commented-out directive examples and replaced them with active ones for better demonstration and testing.
2026-01-03 10:30:39 +01:00
Dennis den Ouden-van der Horst
f481588509 Update child theorem to axiom and add Sphinx theme
Changed the label from 'A child theorem' to 'A child axiom' in the intro.md file for clarity. Added 'sphinx-tudelft-theme==1.2.1' to requirements.txt to specify the documentation theme.
2026-01-02 20:08:02 +01:00
Dennis den Ouden-van der Horst
f9e4a0f0b7 Improve gated directive nesting validation and docs
Added a robust validate_SE function to check for correct nesting of start and end directives, with detailed error reporting. Updated the CheckGatedDirectivesTransform to use this validation and improved error messages for mismatched or incorrectly nested directives. Extended intro.md with comprehensive examples of nested directives, including both valid and invalid cases, to document and test the new behavior. Also added the sphinx_tudelft_theme extension in _config.yml.
2026-01-02 20:05:44 +01:00
Dennis den Ouden-van der Horst
a5f014ddf6 Replace logo figure with nothing.svg in intro
Added a new SVG file 'nothing.svg' and updated the intro.md to use this image in place of the previous logo-wide.svg. Adjusted figure attributes and alt text accordingly.
2026-01-02 17:55:31 +01:00
Dennis den Ouden-van der Horst
bd47d63475 Remove debug logging and update intro content
Debug logging statements were removed from MergeGatedDirectivesTransform in sphinx_gated_directives. The intro.md file was updated to include new theorem and figure directive examples, code cells, and additional documentation content.
2026-01-02 17:40:03 +01:00
Dennis den Ouden-van der Horst
fddd493e39 Comment out legacy registry logic in sphinx_gated_directives
Commented out the code related to the 'sphinx_gated_directives_registry' in favor of using only the 'sphinx_gated_directives_super_registry'. Updated purge and transform logic accordingly. Added clarifying comments to code-align.css regarding left alignment enforcement.
2026-01-02 17:18:18 +01:00
Dennis den Ouden-van der Horst
c7486c0b42 Add sphinx_gated_directives extension and code-align CSS
Introduces the custom Sphinx extension 'sphinx_gated_directives' for start/end directive gating and validation, registering it in the Sphinx local extensions. Also adds a CSS file to enforce left alignment for code cells. Updates _config.yml to configure the new extension and set the documentation language to English.
2026-01-02 17:09:33 +01:00
Dennis den Ouden-van der Horst
b56ad3336b Update requirements and fix BibTeX formatting
Pinned TeachBooks-Favourites to version v1.7.3 in requirements.txt for reproducibility. Added a missing comma and newline in references.bib to correct BibTeX formatting.
2025-12-23 15:51:43 +01:00
Dennis den Ouden-van der Horst
64c1647ca5
Update references.bib 2025-12-23 13:23:12 +01:00
Dennis den Ouden-van der Horst
0bac6738ea
Add TeachBooks logo reference to bibliography 2025-12-19 16:27:34 +01:00
Tom van Woudenberg
b3469006d4
reorder 2025-12-19 13:55:25 +01:00
Tom van Woudenberg
88c67fe4cd
fix url 2025-12-19 13:48:14 +01:00
Tom van Woudenberg
025b2ff5c7
Update plotyl instructions 2025-12-19 13:32:17 +01:00
Dennis den Ouden-van der Horst
eeb71c404d
Update favourites.md 2025-12-17 13:10:24 +01:00
Tom van Woudenberg
ff67aa5572
Add Sphinx last updated by git to favourites list 2025-12-15 18:08:27 +01:00
Dennis den Ouden-van der Horst
9ac3763de0
Add comment to external link in _toc.yml 2025-12-09 10:51:46 +01:00
Dennis den Ouden-van der Horst
ce760deb7b
Remove comment from external link in _toc.yml 2025-12-09 10:41:55 +01:00
Dennis den Ouden-van der Horst
7330aae9fd
Update external link in _toc.yml 2025-12-09 10:37:13 +01:00
Tom van Woudenberg
00e40c5be7
Update external link comment in _toc.yml 2025-12-08 20:32:06 +01:00
Tom van Woudenberg
774882515e
Update external link comment in _toc.yml 2025-12-08 20:17:03 +01:00
Tom van Woudenberg
19120550e9
Add comment to external link in _toc.yml 2025-12-08 20:10:25 +01:00
Tom van Woudenberg
2d7633c496
Fix link for Sphinx Metadata Figure in favourites.md
Updated the link for Sphinx Metadata Figure to point to the correct manual file format.
2025-12-08 20:08:47 +01:00
Tom van Woudenberg
45b20ffdc6 Update sphinx-iframes 2025-12-05 11:31:42 +01:00
Tom van Woudenberg
73a4095358 Update _toc.yml 2025-12-03 12:38:47 +01:00
Tom van Woudenberg
0f48b93776 prepare for updates 2025-12-03 12:37:47 +01:00
Tom van Woudenberg
9bdbb866dc
Change execute_notebooks setting to 'auto' 2025-12-03 12:19:19 +01:00
Tom van Woudenberg
6b868f3d8e Update _toc.yml 2025-12-03 12:14:00 +01:00
Tom van Woudenberg
a2eb698b21 Update _toc.yml 2025-12-03 12:03:07 +01:00
Tom van Woudenberg
8ce33ecfee test 2025-12-03 11:57:21 +01:00
Tom van Woudenberg
b4fbdd90b2
Update _toc.yml 2025-12-01 09:15:51 +01:00
Tom van Woudenberg
eb219bfa06
Add Sphinx Metadata Figure to favourites list 2025-12-01 09:02:37 +01:00
dependabot[bot]
61b5773818
Bump book/external/sphinx-iframes from d92bc03 to b0fcde7
Bumps [book/external/sphinx-iframes](https://github.com/TeachBooks/sphinx-iframes) from `d92bc03` to `b0fcde7`.
- [Release notes](https://github.com/TeachBooks/sphinx-iframes/releases)
- [Commits](d92bc03af5...b0fcde7e89)

---
updated-dependencies:
- dependency-name: book/external/sphinx-iframes
  dependency-version: b0fcde7e8957babcbda79bf861f6c2e2885c0df4
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-30 22:05:40 +00:00
Tom van Woudenberg
130a5e3755
Add style settings for metadata figure placement 2025-11-28 15:16:16 +01:00
Tom van Woudenberg
256163c70b
Add external link to Sphinx-Metadata-Figure manual 2025-11-28 11:22:56 +01:00
Tom van Woudenberg
00c79afade
Update _config.yml 2025-11-28 11:22:19 +01:00
dependabot[bot]
ebaa8a329a
Bump book/external/JupyterBook-Patches from 13aa698 to c5cb27a
Bumps [book/external/JupyterBook-Patches](https://github.com/TeachBooks/JupyterBook-Patches) from `13aa698` to `c5cb27a`.
- [Release notes](https://github.com/TeachBooks/JupyterBook-Patches/releases)
- [Commits](13aa6988c6...c5cb27a87b)

---
updated-dependencies:
- dependency-name: book/external/JupyterBook-Patches
  dependency-version: c5cb27a87b193228c45edb95580f9ee2d82b27df
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-25 07:38:23 +00:00
Tom van Woudenberg
7f6d421370
Add Sphinx GitHub Alerts to favourites list 2025-11-20 15:33:31 +01:00
Dennis den Ouden-van der Horst
44b912e01f Add sphinx-github-alerts extension support
Integrated the sphinx-github-alerts extension into the Sphinx configuration, requirements, and documentation table of contents to enable GitHub alerts functionality.
2025-11-20 15:10:35 +01:00
Robert Lanzafame
8f41fb6429
update apa page 2025-11-18 21:23:04 -08:00
Dennis den Ouden-van der Horst
9e531c7e5f Remove custom bibtex styles and add APA warning info
Removed custom bibtex style settings from _config.yml. Added documentation in apa.md about handling duplicate label warnings in APA references, including advice on adding letters to years in .bib files.
2025-11-17 17:08:31 +01:00
Dennis den Ouden-van der Horst
7117d92eed Switch to sphinx-apa-references extension for APA style
Removed local APA style extensions and related static files, updated _config.yml to use the sphinx_apa_references extension, and revised documentation in apa.md to reflect installation and usage of the new package. Added sphinx-apa-references to requirements.txt and references.bib now includes a multi-author example for APA citation demonstration.
2025-11-17 16:48:07 +01:00
Tom van Woudenberg
6315eedc2d
Add files via upload 2025-11-14 10:16:54 +01:00
Tom van Woudenberg
7de255e2a5
Update apastyle.css 2025-11-14 10:15:45 +01:00
Tom van Woudenberg
d6c590ea69
Merge pull request #214 from TeachBooks/dependabot/submodules/book/external/Download-Link-Replacer-03feccf
Bump book/external/Download-Link-Replacer from `be4b093` to `03feccf`
2025-11-08 15:22:51 +01:00
dependabot[bot]
391bb36a38
Bump book/external/Download-Link-Replacer from be4b093 to 03feccf
Bumps [book/external/Download-Link-Replacer](https://github.com/TeachBooks/Download-Link-Replacer) from `be4b093` to `03feccf`.
- [Release notes](https://github.com/TeachBooks/Download-Link-Replacer/releases)
- [Commits](be4b09352b...03feccf6ef)

---
updated-dependencies:
- dependency-name: book/external/Download-Link-Replacer
  dependency-version: 03feccf6efa55d14da78cf4259cedb8a7585ad91
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-08 14:18:55 +00:00
dependabot[bot]
e399e60845
Bump book/external/Sphinx-PRIME-applets from 6217c86 to cf88491
Bumps [book/external/Sphinx-PRIME-applets](https://github.com/TeachBooks/Sphinx-PRIME-applets) from `6217c86` to `cf88491`.
- [Release notes](https://github.com/TeachBooks/Sphinx-PRIME-applets/releases)
- [Commits](6217c86263...cf8849136e)

---
updated-dependencies:
- dependency-name: book/external/Sphinx-PRIME-applets
  dependency-version: cf8849136e1303e1a2fa2a8ed7296cde6b3b2d68
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-08 14:18:53 +00:00
Tom van Woudenberg
b1b9d673b2
Fix formatting in TeachBooks manual introduction 2025-11-04 08:53:59 +01:00