search

AlexsLemonade / scpca-docs

User information about ScPCA processing
https://scpca.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Add documentation for celltype annotation #134

Closed sjspielman closed 1 year ago

sjspielman commented 1 year ago

Closes #130

This PR adds docs for cell typing as described in #130, largely based on the comments I wrote after the issue was opened. Let me know where I can tweak any phrasing, what can use more or less detail, etc. Also, anything I am entirely missing?

sjspielman commented 1 year ago

Hm, what's the deal with this readthedocs failure? I definitely did not delete our config file..?

sjspielman commented 1 year ago

@allyhawkins I've implemented changes you requested here, but I do not know why the build is failing since the config is definitely present 🤷‍♀️

allyhawkins commented 1 year ago

@allyhawkins I've implemented changes you requested here, but I do not know why the build is failing since the config is definitely present 🤷‍♀️

I think it might be related to this? https://blog.readthedocs.com/migrate-configuration-v2/

Looks like we need to use a new config file?

sjspielman commented 1 year ago

I think it might be related to this? https://blog.readthedocs.com/migrate-configuration-v2/

Oof yeah, those deprecation dates...yeah. I will go ahead and look into this separately!

sjspielman commented 1 year ago

Github is a mess right now, so who knows if this comment goes through...but I'm actually wondering if this build fail is not our fault and somehow related to github actions being a mess. Indeed, our config is already at v2 syntax..? Let's wait and see here!

Edit: Hm, ok, maybe we really do need to update something, but given similar failures in #141, 🤷‍♀️

sjspielman commented 1 year ago

Alright, we're all set with a fixed config situation in #141, back on track!

sjspielman commented 1 year ago

Noting that https://github.com/AlexsLemonade/scpca-docs/pull/134/commits/66d2a7f9873a9921912a202dcd8cbfe1836748aa fixes a silly oversight in #141 where the config file was copied instead of moved..! Hopefully this all now builds!

Edit: 🚀 built!