scverse / scverse/scverse-misc

move generic docs stuff to `scverse-doc`?

Open
#78 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5
Forks
2
Avg merge
11h 10m
Merged PRs (30d)
13

Description

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 …

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the changes in #60 and reviewing the existing scverse-misc documentation support alongside scverse-doc. Compare the proposed dependency and extension-loading options, then define where generic documentation features should live and how users should activate them.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.