Improve structure of docs.

Question

Improve structure of docs.

Opened this issue 4 years ago · 3 comments

The deepmod class is our base and its combined together with all the other abstract classes. I'm not sure this is the most clear; should we move the abstract classes to each instance it belongs to? @GijsVermarien @remykusters @georgestod What do you think?

Answer 1 · 2020-11-04T10:47:37.000Z

Yes, I fully agree on that one, it was confusing to me as well.

Answer 2 · 2020-11-04T11:08:00.000Z

Also agreed, maybe we can provide a documentation piece on the abstract base classes in the documentation separated from the code.

Answer 3 · 2020-11-04T12:44:54.000Z

I have not fully understood the structure of the docs yet. What would help maybe would be to inspire from a typical scikit-learn documentation: parameters, attributes + methods (and then parameters + returns).