v1.11.2 - Doctest Utilities and Configuration Refinement

📃 Overview

Introduce new utility functions for executing doctests and refine the configuration loading process to better handle unordered sections. This release also standardises documentation metadata and improves the reliability of the coverage reporting workflow.

✨ New Features

🔍 Integrate Doctest Checking Functions

Introduce automated doctest execution to verify code examples within docstrings.

• Implement the check_doctest() function in src/utils/scripts.py to run doctests across all Python files in the package.
• Implement the check_doctest_module() function to target specific modules for doctest validation.
• Implement the check_doctest_cli() function to provide a command-line interface for module-specific doctest checking.

🐛 Bug Fixes

⚙️ Refine Configuration Order Validation

Resolve an issue where multiple sections without an explicit order value caused duplicate key errors.

• Update the SectionConfig() class to consistently allow None for the order attribute.
• Update the _parse_sections_config() function in config.py to remove the default value of 0 when extracting order from configuration data.
• Ensure that sections without an explicit order are correctly sorted to the end of the validation sequence.

⚙️ Technical Improvements

🚀 Enhance Project Workflow

Improve the robustness of the development and documentation workflows.

• Update the git_add_coverage_report() function to use the --force flag when adding the coverage report directory, ensuring reports are captured regardless of ignore rules.
• Fix typographical errors and standardise the project title to docstring-format-checker across documentation files.
• Refine the documentation home page to use a dedicated coverpage_icon_source variable in mkdocs.yaml for better maintainability.

💪 Pull Requests

• Enhance Configuration Handling for non-Ordered Sections by @chrimaho in #37

Full Changelog: v1.11.1...v1.11.2