evidently icon indicating copy to clipboard operation
evidently copied to clipboard

API documentation in repo

Open emeli-dral opened this issue 4 years ago • 1 comments

In addition to the existing documentation, we need to document the API.

Since such documentation is generated automatically, and the codebase is not entirely covered with comments, we shall do it step-by-step. As a first step, I suggest we:

  • [ ] upload the first version of the automatically generated documentation
  • [ ] upload the instructions for building the docs from the repository

This will allow us to:

  1. see how the API documentation looks now and iteratively improve the content and visuals
  2. give the users the opportunity to build it from the repository according to the instructions

emeli-dral avatar Jan 20 '22 17:01 emeli-dral

Any thoughts on what you want to use? shpinx? readthedocs?

burkovae avatar Feb 18 '22 17:02 burkovae