search

scverse / squidpy_notebooks

Tutorials for Squidpy
https://squidpy.readthedocs.io/en/stable/
MIT License
28 stars 17 forks source link

update contributing guide #69

Closed hspitzer closed 3 years ago

hspitzer commented 3 years ago

Quick reminder to integrate stuff discussed in #64 to contributing guide (how docs are regenerated, manual update of examples.rst in main repo)

michalk8 commented 3 years ago

I think most has been added there in #64 , except maybe for examples.rst update. Regarding this we can also when generating the docs in main repo, copy examples.rst, tutorials.rst and references.{bib,rst} and use those (easy to do, maybe more convoluted). Unrelated to above, I'd suggest adding default glob to both {examples,tutorials}.rst so that missing examples as mentioned in https://github.com/theislab/squidpy/issues/366#issuecomment-862503505 don't happen (I'd rather have then all up, even if the order is sub-optimal).

michalk8 commented 3 years ago

@hspitzer I believe this can be closed once #74 (added 1 sentence on where to add examples/tutorials); also please ignore the glob for examples/tutorials, since they are files from diff. directories are in different sections.

hspitzer commented 3 years ago

yes, sounds good!

Unrelated to above, I'd suggest adding default glob to both {examples,tutorials}.rst so that missing examples as mentioned > in heislab/squidpy#366 (comment) don't happen (I'd rather have then all up, even if the order is sub-optimal).

you mean ignore this comment? Ok!

michalk8 commented 3 years ago

you mean ignore this comment? Ok!

Yes, thanks.

closed via #74