Feature: Autogenerate Documentation From The Code Base

[palisadoes]

Is your feature request related to a problem? Please describe.

1. The repository uses Docstrings formatted according to the Google standard.
   1. https://google.github.io/styleguide/pyguide.html#doc-function-raises
2. We need to use this autogenerate documentation

This feature is required in anticipation of GSoC 2025

Describe the solution you'd like

Pull Request 1

1. We need a script to check the entire code base for compliance with this standard
2. The script must:
   1. reside in the .github/workflows/scripts directory
   2. be run as part of every pull-request
   3. use this python pip library
      1. https://github.com/rr-/docstring_parser
   4. provide the user with the following for each file in violation:
      1. The name of the failed file
      2. The line number of the incompatibility
      3. The nature of the incompatibility
      4. The corrective action
3. The pip package must be added to the requirements.txt file
4. The person assigned this issue must use the script to fix all python files incompatible python files that do not conform

Pull Request 2

1. We need to autogenerate markdown files based on the Docstrings
2. This must be in the form of a python script so for easy troubleshooting
3. Any one of many pip packages compatible with the Google Docstring standard can be used:
   1. https://pypi.org/project/pydoc-markdown/
   2. https://github.com/davidenunes/mkgendocs
4. The output must be:
   1. in a format that is consumable by docusaurus with an auto-generated sidebar
   2. The final markdown output must be placed in the docs/auto-docs directory
   3. Docusaurus must process the files correctly and add them to its web pages
5. The pip package must be added to the requirements.txt file
6. Any intermediary files must:
   1. all be placed under the docs-temp/ directory
   2. be removed from the code base after the script is complete
   3. be added to the .gitignore file to prevent them being uploaded to the repository

Describe alternatives you've considered

• See above

Approach to be followed (optional)

• See above

Additional context

• N/A

Potential internship candidates

Please read this if you are planning to apply for a Palisadoes Foundation internship

• Student Internship Programs talawa#359

[mandeepnh5]

Can i work on this issue?

[palisadoes]

1. Thanks for the effort
2. Please work on the next task.