Skip to content

move generic docs stuff to scverse-doc? #78

Description

@flying-sheep

OK, so scverse-doc now almost exists. Should we move generic docs stuff there? E.g. some or all of what was added in #60 is not related to any runtime feature scverse-misc offers.

I wonder how we should handle it:

should scverse-doc depend on scverse-misc[sphinx] and load its extension? Then people could choose:

  • dependency-groups.docs = [ "scverse-doc" ] and extensions = ["scverse_doc"] gives them all scverse-doc features and all the scverse-misc features they activate in their project.dependencies
  • dependency-groups.docs = [ "scverse-doc" ] and extensions = ["scverse_doc.foo"] gives them only the subextensions they want (like scanpydoc)
  • dependency-groups.docs = [ "scverse-misc" ] and extensions = ["scverse_misc.sphinx_ext"] give them just docs support for the runtime features, no additional docs features

but we’ve already deviated from that with #60

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions