gama-platform / gama.experimental

Home of experimental plugins for GAMA
13 stars 6 forks source link

Generating wikis for experimental plugins #35

Open PaulBreugnot opened 1 year ago

PaulBreugnot commented 1 year ago

Currently, the GAMA documentation generation process only works for the main gama project, generating documentation from @doc annotations of projects in the gama folder. Plugins not referenced in the gama.product are documented as "extensions", but they still need to be in the gama project folder, even if plugins from gama.experimental are imported in the same Eclipse workspace as gama.

Documentation of @doc annotations of experimental plugins are available as tooltips from Gama, but I would like to also take advantage of those annotations to generate wikis about the usage of each plugin. This might help to solve issue #27.

Even if wikis are not generated for experimental plugins with the MainGenerateWiki.java tool, docGAMA.xml files are still generated for them (not sure exactly what build process is responsible for this). In consequence, it is possible to run the msi.gama.documentation on the gama.experimental plugins with little hacks.

Here is a proof of concept with the chemmisol plugin I am currently developing:

Screenshot from 2023-09-07 15-13-32

Screenshot from 2023-09-07 15-14-05

The msi.gama.documentation project is not yet adapted to experimental plugins, since the source and destination directories are hardcoded. I however think the tool could be easily improved to make it more generic and adaptable.

Adapting the gama.wiki base files in the gama.experimental.wiki files (e.g. Home.md, _Sidebar.md, ...) should then be enough to generate a gama.experimental wiki containing the @doc based documentation of all experimental plugins.

Since a wiki would be very helpful for the usage of my plugin, I think I could try to make this feature available if the Gama team thinks it is relevant.

lesquoyb commented 1 year ago

I think it could be a good idea yes, especially since we have plugins like genstar that used to be in the kernel (and thus to had their automatic documentation on the website) that moved to experimental. What are your thoughts @AlexisDrogoul ?

AlexisDrogoul commented 1 year ago

Good idea indeed -- we just need to find time to do it ?