earmingol / cell2cell

User-friendly tool to infer cell-cell interactions and communication from gene expression of interacting proteins
BSD 3-Clause "New" or "Revised" License
56 stars 12 forks source link

cell2cell ReadTheDocs API Reference #62

Open IsaacUtah1379 opened 2 months ago

IsaacUtah1379 commented 2 months ago

The cell2cell ReadTheDocs page seems to have an incomplete API reference page. It describes cell2cell a bit, lists the different cell2cell modules, then says "Below, all the inputs, parameters (including their different options), and outputs are detailed. Source code of the functions is also included." Nothing is below this line, however. The github.io page does begin documenting the API below this point, but it's a bit hard to read. It would be nice to have a ReadTheDocs version, which theoretically would be easier to read.

cell2cell ReadTheDocs: screenshot

earmingol commented 1 month ago

Thanks for reporting this. Once I find time I'll try fixing this!