Enhance API Reference Documentation for nnbench

[leonpawelzik]

Enhance API Reference Documentation for nnbench

Similar to lakefs-spec (aai-institute/lakefs-spec#273 (review)), we would like to make improvements to the API reference documentation generation for the nnbench library. The proposed changes include:

1. Extracting module docstrings for root-level modules:
   • Update the gen_api_ref_pages.py script to extract the module docstrings for root-level modules in the package.
   • Add the extracted docstrings to the index page of the API reference.
   • Utilize the docstring_parser library to parse the docstrings.
2. Adding links to root-level modules on the index page:
   • Include links to the root-level modules on the index page of the API reference.
   • Generate these links automatically based on the navigation structure.
3. Updating dependencies:
   • Add the docstring-parser library to the documentation dependencies in pyproject.toml.

These enhancements aim to provide a more comprehensive and user-friendly API reference documentation for the nnbench library. The inclusion of module docstrings and links to root-level modules will make it easier for users to navigate and understand the library's structure and functionality.

[leonpawelzik]

Solved with #123