175 enable documentation process

Summary by Sourcery

Enhance the atom configuration by adding functions to retrieve allowed and argument Python types, introduce a new timeline configuration file, refactor CSV handling functions, and improve error messages. Add new tests to ensure the correctness of these changes and introduce a new pytest option for test parameterization.

New Features:

Introduce functions to retrieve allowed Python types and atom argument Python types in the atom configuration.
Add a new JSON configuration file for a timeline labeled 'Lizzy9' with specific configurations for hours, months, and weekdays.

Bug Fixes:

Correct error messages in set_max_tree_traverse and _allot_missing_scale functions to improve clarity.

Enhancements:

Refactor the create_changeunit and load_stone_csv functions to remove the x_stonename parameter and derive it internally.
Improve the get_sorted_headers function by utilizing a new helper function create_sorted_concatenated_str for string concatenation.
Add a new command-line option --big_volume to the pytest configuration to allow parameterization of tests based on this option.

Tests:

Add tests for new functions get_python_type, get_allowed_python_types, and get_atom_args_python_types to ensure they return expected results.
Add a test for the new get_positional_dict function to verify its correctness.

Reviewer's Guide by Sourcery

This pull request implements several changes related to the documentation process, including updates to atom configuration, stone format handling, and various test improvements. The changes primarily focus on enhancing type handling, refactoring existing functions, and adding new utility functions to support the documentation process.

File-Level Changes

Change	Details	Files
Added new functions for handling Python types in atom configuration	Implemented get_allowed_python_types() function to return a set of allowed Python types Created get_atom_args_python_types() function to return a dictionary of atom arguments and their corresponding Python types Added tests for the new functions in test_atom_config.py	`src/gift/atom_config.py` `src/gift/test_atom/test_atom_config.py`
Refactored stone format handling and CSV loading	Modified create_changeunit() function to determine stone name from CSV headers Updated load_stone_csv() function to remove x_stonename parameter Refactored test cases to reflect changes in stone format handling	`src/stone/stone.py` `src/stone/test_stone/test_stone_format_generate_stone.py`
Added new utility functions for string and list operations	Implemented create_sorted_concatenated_str() function to create a sorted, comma-separated string from a list Added get_positional_dict() function to create a dictionary of list elements and their positions Created tests for the new utility functions	`src/_instrument/python_tool.py` `src/_instrument/test/test_python.py`
Updated test configuration to support big volume tests	Added --big_volume option to pytest configuration Modified test cases to use the big_volume flag for conditional execution	`conftest.py` `src/stone/test_stone/test_stone_format_import.py`
Improved error messages and documentation	Updated error messages in bud.py for better clarity Modified documentation strings in various test files Adjusted legible text generation for max_tree_traverse in gift/legible.py	`src/bud/bud.py` `src/bud/test_bud/test_bud_.py` `src/gift/legible.py` `src/gift/test_change/test_change_legible_budunit.py`
Added new timeline configuration file	Created timeline_config_lizzy9.json with specific configuration for a new timeline	`src/chrono/examples/timeline_config_lizzy9.json`

Tips

- Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.

jschalk / jaar