Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract custom sphinx stuff to package #113

Open
flying-sheep opened this issue Oct 24, 2022 · 5 comments
Open

Extract custom sphinx stuff to package #113

flying-sheep opened this issue Oct 24, 2022 · 5 comments

Comments

@flying-sheep
Copy link
Member

flying-sheep commented Oct 24, 2022

#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
Copy link
Member

adamgayoso commented Feb 24, 2023

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

@grst
Copy link
Collaborator

grst commented Feb 24, 2023 via email

@adamgayoso
Copy link
Member

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
Copy link
Member Author

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
Copy link
Member

Zethson commented Apr 27, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants