Documentation and contribution guide

[Fran-cois]

Status:

The documentation is very clear to execute and change parameters. However, it can be tricky to contribute to the project.

Proposal:

Use javasphinx + readthedoc.io

javaphinx : https://bronto-javasphinx.readthedocs.io/en/latest/
readthedocs: https://readthedocs.org/

[lgalarra]

Hi François,

Could you please elaborate on the advantages of using this tool compared to the standard Javadoc tool?

Cheers,
Luis

[Fran-cois]

Hello Luis,

I think that using sphinx doc has several advantages :

• It is more flexible than Javadoc, indeed we can add other information in the doc such as tutorials, demo or even contribution guide.
• With the javasphinx library, we also have all the advantages of the javadoc (automatic doc from comments). The javadoc can also be generated.
• It may be easier to attract new contributors from the ML/AI scene. Indeed, most of the python libraries use this kind of documentation.
• Free hosting with https://readthedocs.org/ I do not know if we can host freely a javadoc (maybe with github pages).

Cheers,
François

[lgalarra]

Hi François,

Thanks for the hints. From what I saw, this tools seems like a nice alternative for us. Shall I assign this task to you?

Best,
Luis