Commit graph

11 commits

Author SHA1 Message Date
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
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
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
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
Robert Lanzafame
440e66a553
tiny change "is" to "==" because Tom doesn't like warnings 2024-12-06 09:27:49 +01:00
Robert Lanzafame
020e345674 add pybtexapastyle 2024-12-05 10:54:21 +01:00
Robert Lanzafame
c054b315a6 add local extension 2024-12-05 10:54:01 +01:00