Commit graph

1813 commits

Author SHA1 Message Date
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
Tom van Woudenberg
7533ef1c0b
Merge pull request #231 from TeachBooks/test-metadata-prerelease
Update requirements and fix BibTeX formatting
2025-12-23 16:02:16 +01:00
Tom van Woudenberg
233df5631e
BUMP without fixing versoin 2025-12-23 16:01:43 +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
Tom van Woudenberg
70727a502e
Merge pull request #229 from TeachBooks/metadata-bibtex-support
Add TeachBooks logo reference to bibliography
2025-12-21 10:10:20 +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
Tom van Woudenberg
bd4516c25e
Merge pull request #228 from TeachBooks/add-last-updated-by-git
Add Sphinx last updated by git to favourites list
2025-12-17 13:16:14 +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
1311109ba3
Merge pull request #227 from TeachBooks/test-glue-disable
Test glue disable
2025-12-09 10:46:03 +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
a0636f0bc8
Update TeachBooks-Favourites dependency version
Updated the TeachBooks-Favourites dependency to a new version.
2025-12-08 20:05:50 +01:00
Tom van Woudenberg
45b20ffdc6 Update sphinx-iframes 2025-12-05 11:31:42 +01:00
Dennis den Ouden-van der Horst
5e55e84522
Merge pull request #225 from TeachBooks/test_metadata
Updates to fit with new notebook in figure-metadata
2025-12-03 14:29:39 +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
d42f4efa49 Merge branch 'test_metadata' of https://github.com/TeachBooks/manual into test_metadata 2025-12-03 12:31:18 +01:00
Tom van Woudenberg
c83987b8be Update requirements.txt 2025-12-03 12:30:49 +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
b4b78f6eea Update requirements.txt 2025-12-03 11:59:27 +01:00
Tom van Woudenberg
91a861c307 fix 2025-12-03 11:59:17 +01:00
Tom van Woudenberg
8ce33ecfee test 2025-12-03 11:57:21 +01:00
Tom van Woudenberg
2a35f37935
Merge pull request #224 from TeachBooks/Tom-van-Woudenberg-patch-1
Update _toc.yml
2025-12-01 09:16:05 +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
Tom van Woudenberg
57ac568c2e
Merge pull request #223 from TeachBooks/dependabot/pip/sphinx-metadata-figure-1.0.3
Bump sphinx-metadata-figure from 1.0.2 to 1.0.3
2025-12-01 08:51:22 +01:00
Tom van Woudenberg
49a5d1af6b
Merge pull request #222 from TeachBooks/dependabot/submodules/book/external/sphinx-iframes-b0fcde7
Bump book/external/sphinx-iframes from `d92bc03` to `b0fcde7`
2025-12-01 08:51:11 +01:00
dependabot[bot]
268ac7142e
Bump sphinx-metadata-figure from 1.0.2 to 1.0.3
Bumps [sphinx-metadata-figure](https://github.com/TeachBooks/Sphinx-Metadata-Figure) from 1.0.2 to 1.0.3.
- [Release notes](https://github.com/TeachBooks/Sphinx-Metadata-Figure/releases)
- [Commits](https://github.com/TeachBooks/Sphinx-Metadata-Figure/compare/v1.0.2...v1.0.3)

---
updated-dependencies:
- dependency-name: sphinx-metadata-figure
  dependency-version: 1.0.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-30 22:05:47 +00: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
a27da88f79
Fix formatting in requirements.txt 2025-11-28 17:09:26 +01:00
Tom van Woudenberg
33613846f6
Update sphinx-metadata-figure version to 1.0.2 2025-11-28 16:28:51 +01:00