search

scverse / cookiecutter-scverse

Cookiecutter template for scverse
https://cookiecutter-scverse-instance.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
70 stars 9 forks source link

Extract custom sphinx stuff to package #113

Open flying-sheep opened 2 years ago

flying-sheep commented 2 years ago

100 did this:

  • Remove scanpydoc dependency
  • Add typed returns custom extension like in scanpy
  • Use same autosummary class template as in scvi-tools (single page for classes with methods/attr tables)

why? shared code should live in a package. let’s revert that part and improve scanpydoc to enjoy shared goodness.

adamgayoso commented 1 year ago

I agree that scanpydoc could have these features (and renamed to scversedoc)

This could also include the custom linkcode functions to link source out to github https://github.com/scverse/cookiecutter-scverse/issues/103

grst commented 1 year ago

Is it that bad to have a bit of vendored code, especially with template sync in place?

On Fri, 24 Feb 2023 at 19:59, Adam Gayoso @.***> wrote:

I agree that scanpydoc could have these features (and renamed to scversedoc)

This could also include the custom linkcode functions to link source out to github #103 https://github.com/scverse/cookiecutter-scverse/issues/103

— Reply to this email directly, view it on GitHub https://github.com/scverse/cookiecutter-scverse/issues/113#issuecomment-1444267856, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABVZRV73UDDUBVSXGCF6PILWZEAJ7ANCNFSM6AAAAAARM5FD3I . You are receiving this because you are subscribed to this thread.Message ID: @.***>

adamgayoso commented 1 year ago

Is it that bad to have a bit of vendored code, especially with template sync in place?

This is also a good point. I'm indifferent. Package makes it easier for people to use without using the template.

flying-sheep commented 1 year ago

I believe minimizing boilerplate and relying just on Git (for your project specific settings) and dependencies (for things maintained by other people) simplifies things. Sure, after learning Git and Python dependency management, some people also want to learn cruft and configure it to deal with boilerplate, but how many of our users are that?

What do you think? How realistic is it that our users will use template sync?

Zethson commented 1 year ago

What do you think? How realistic is it that our users will use template sync?

In practice, quite a few people get lazy with updating it. Nevertheless, these people also wouldn't update their scverse-doc dependencies.

But that shouldn't stop us from using any option