Document library

[Laouen]

The idea is to use python docstring and then genere an automatic documentations in CI/CD from the docstring

[Laouen]

Modules already documented

• measures gaussian copula
• collectors

Module to document:

• greedy
• simulated_annealing_multi_order
• hot_encode_to_indexes
• simulated_annealing
• random_sampler
• nplets_measures_hot_encoded
• multi_order_measures_hot_encoded
• gaussian_copula
• gaussian_copula_covmat

[Miguel-Escobar]

Hello, I'm looking to contribute with documenting. Are there any guidelines on the documentation style?

[Laouen]

Hi @Miguel-Escobar glad to hear you want to contribute in this project 😊

We started doing the documentation using the standard sklearn doctring format to then use automatic tools.

I'm currently on vacation until February, but if you want to start documenting you can start and do PRs. And if you need us to do a meeting, we can do one in February!

[Miguel-Escobar]

Thank you! I'll get more into it soon, maybe then I'll leave more messages.