Precompute scripts

[jinan02]

Quick description

Summary: This pull request introduces a new script that iterates over all Python scripts in the scripts directory, runs each script with the -h flag to generate help text, and saves the output to corresponding hidden files in the .hidden directory. This precomputes the help outputs for each script, facilitating faster searches or documentation purposes.

Motivation and Context: The motivation behind this change is to improve the efficiency of generating help outputs for scripts, avoiding the need to dynamically generate help text each time it's needed. This also helps in keeping the main scripts directory uncluttered by storing these outputs in a hidden directory.

Dependencies: No additional dependencies are required for this change.

Type of change

Check the relevant options.

• [ ] Bug fix (non-breaking change which fixes an issue)
• [x] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] This change requires a documentation update

Provide data, screenshots, command line to test (if relevant)

Data: Not applicable.

Command line to test: Run the new script in the scripts directory:

python generate_help_files.py

Checklist

• [x] My code follows the style guidelines of this project (run [autopep8](https://pypi.org/project/autopep8/))
• [x] I added relevant citations to scripts, modules and functions docstrings and descriptions
• [x] I have performed a self-review of my code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [ ] I moved all functions from the script file (except the argparser and main) to scilpy modules
• [] I have added tests that prove my fix is effective or that my feature works
• [] New and existing unit tests pass locally with my changes

[jinan02]

cancel PR