Automata Documentation Files Generation Alters Git State

[RKALM]

Describe the bug
Upon running the generate_faq.py and sphinx-build -a . docs scripts, additional files get created within the ./docs/docs directory. These files are currently not ignored by the Git configuration, causing uncommitted changes to be present in the working directory.

To Reproduce
Steps to reproduce the behavior:

1. Navigate to the docs directory in the Automata root folder.
2. Run python generate_faq.py.
3. Run sphinx-build -a . docs.
4. Observe the creation of new files within the ./docs/docs directory.

Expected behavior
The ./docs/docs directory should be added to the .gitignore file to avoid tracking unnecessary files.

Screenshots
Not applicable.

Desktop:

• OS: Windows
• Git Bash / Git Desktop

Smartphone:
Not applicable.

Additional context
These auto-generated files are not needed in the repository, and their presence may confuse contributors. Including the ./docs/docs directory in .gitignore would solve this issue.

Notably, some files outside the ./docs/docs directory, which already existed, are being modified during the documentation generation process. I acknowledge these modifications as intended and beneficial. Therefore, I plan to commit these files to the repository after the documentation generation. This strategy ensures that all essential updates are incorporated while excluding unnecessary, auto-generated files.

[RKALM]

During my investigation, it came to my attention that the Sphinx documentation generation tool outputs its build files in a _build subdirectory. This explains why this folder is included in the .gitignore file. This configuration allows us to maintain a clean Git status by excluding these automatically generated files, which can easily be rebuilt from the source files. With this understanding, it's clear that the system is functioning as intended. Therefore, we can consider this issue resolved. Thanks for your understanding.!