Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate automatically list of functions and parameters in a page in the documentatino setup #104

Open
maxradx opened this issue Nov 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request priority low Easy to fix or can wait.

Comments

@maxradx
Copy link
Member

maxradx commented Nov 18, 2024

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
image

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.

@maxradx maxradx added documentation Improvements or additions to documentation enhancement New feature or request priority low Easy to fix or can wait. labels Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request priority low Easy to fix or can wait.
Projects
None yet
Development

No branches or pull requests

1 participant