Generate automatically list of functions and parameters in a page in the documentatino setup #104
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
priority low
Easy to fix or can wait.
Is your feature request related to a problem? Please describe.
Some best practices have been proposed regarding documentation for software/platforms, but approach relies on the technology being used.
Describe the solution you'd like
Ability to generate in a file related to documentation a description of the functions used by the software and their paramaters. Example from: https://shimming-toolbox.org/en/latest/api_reference/api.html
Other good example: documentation as in sci-kit learn
Describe alternatives you've considered
PyDocs
Additional context
Will be considered after a PR with up-to-date documentation will be done.
The text was updated successfully, but these errors were encountered: