amuse icon indicating copy to clipboard operation
amuse copied to clipboard

Move documentation of codes to code directory and (semi) autogenerate

Open ipelupessy opened this issue 3 years ago • 1 comments

Is your feature request related to a problem? Please describe. The documentation of the currently available codes is out of date

Describe the solution you'd like I think its best if we move the documentation to the code directory, where its semi auto-generated from information in the interface.py (docstrings, autoclass thingy etc). Current descriptions should move into the docstrings (most cases they are copied from there?), tables with parameters are not necessary. Ideal case some information about data stores is also autogenerated.

Describe alternatives you've considered curent strategy of updating the doc files

ipelupessy avatar Jul 02 '22 17:07 ipelupessy