API Documentation incomplete

[KonradHoeffner]

For example, there is no documentation on https://ayuei.github.io/DeBEIR/debeir/core/pipeline.html.
Please provide the missing documentation and add to the readme file, how it is generated.
This issue is part of the JOSS review at openjournals/joss-reviews#5017.

[Ayuei]

Can you clarify what you mean by "how it is generated", does this mean the tool/library used to generate the documentation?

[KonradHoeffner]

Yes, it would be nice to know after checking out the repository, how to generate the documentation.
But it doesn't need another full sentence, for example you could extend "Otherwise, html rendered documentation is available here" to something like "Otherwise, documentation generated by python insertdoctoolhere is available here."
HTML should be uppercase if you keep it.

[Ayuei]

Hi, I added more documentation for all the components and added more examples for usage. I'll continually update this as there are still some spelling mistakes and missing documentation. But the core documentation should be there for users to get started.

I also included in the README.md how the documentation is generated and how to generate it yourself.

[KonradHoeffner]

Thanks! I will check the appropriate box in the review, however I will leave this issue open as you said there is still missing documentation.